Version v2 of the Content API is scheduled for sunset on September 30th, 2021. Onboarding to v2 will stop on April 30, 2021. To avoid disruptions with your integration, please migrate to v2.1 as soon as possible.

For more information, see Migrating to v2.1 and this blog post.

Method: shippingsettings.getsupportedcarriers

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 (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. 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.