getsupportedcarriers method

Future<ShippingsettingsGetSupportedCarriersResponse> getsupportedcarriers(
  1. String merchantId, {
  2. String? $fields,
})

Retrieves supported carriers and carrier services for an account.

Request parameters:

merchantId - The ID of the account for which to retrieve the supported carriers.

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

Completes with a ShippingsettingsGetSupportedCarriersResponse.

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

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

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