Method: shippingsettings.getsupportedcarriers

Retrieves supported carriers and carrier services for an account.

HTTP request

GET https://www.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
  • https://www.googleapis.com/auth/structuredcontent

For more information, see the OAuth 2.0 Overview.

CarriersCarrier

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

string

The name of the carrier (e.g., "UPS"). Always present.

country

string

The CLDR country code of the carrier (e.g., "US"). Always present.

services[]

string

A list of supported services (e.g., "ground") for that carrier. Contains at least one service.

Try it!