list method

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

Lists the shipping settings of the sub-accounts in your Merchant Center account.

Request parameters:

merchantId - The ID of the managing account. This must be a multi-client account.

maxResults - The maximum number of shipping settings to return 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 ShippingsettingsListResponse.

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<ShippingsettingsListResponse> list(
  core.String merchantId, {
  core.int? maxResults,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

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

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