Method: shippingsettings.getsupportedcarriers

  • Retrieves the supported shipping carriers and their services for a specific Merchant Center account.

  • Requires authorization with the https://www.googleapis.com/auth/content scope.

  • Response includes carrier details such as name, country, supported services, and services eligible for estimated delivery date calculation.

  • The request is made with an HTTP GET to the URL https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/supportedCarriers, replacing {merchantId} with the account ID.

  • The response is a JSON object containing a list of supported carriers, each with details of their services.

Retrieves supported carriers and carrier services for an account.

HTTP request

GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/supportedCarriers

Path parameters

Parameters
merchantId

string

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

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "kind": string,
  "carriers": [
    {
      object (CarriersCarrier)
    }
  ]
}
Fields
kind

string

Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedCarriersResponse".
carriers[]

object (CarriersCarrier)

A list of supported carriers. May be empty.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

CarriersCarrier

JSON representation 
{
  "name": string,
  "country": string,
  "services": [
    string
  ],
  "eddServices": [
    string
  ]
}
Fields
name

string

The name of the carrier (for example, "UPS"). Always present.
country

string

The CLDR country code of the carrier (for example, "US"). Always present.
services[]

string

A list of supported services (for example, "ground") for that carrier. Contains at least one service. This is the list of valid values for CarrierRate.carrierService.
eddServices[]

string

A list of services supported for EDD (Estimated Delivery Date) calculation. This is the list of valid values for WarehouseBasedDeliveryTime.carrierService.