list method

Future<ReturnaddressListResponse> list(
  1. String merchantId, {
  2. String? country,
  3. int? maxResults,
  4. String? pageToken,
  5. String? $fields,
})

Lists the return addresses of the Merchant Center account.

Request parameters:

merchantId - The Merchant Center account to list return addresses for.

country - List only return addresses applicable to the given country of sale. When omitted, all return addresses are listed.

maxResults - The maximum number of addresses in the response, used for paging.

pageToken - The token returned by the previous request.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ReturnaddressListResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<ReturnaddressListResponse> list(
  core.String merchantId, {
  core.String? country,
  core.int? maxResults,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (country != null) 'country': [country],
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = commons.escapeVariable('$merchantId') + '/returnaddress';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ReturnaddressListResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}