rocket
Meet
Merchant API
- the official successor to Content API for Shopping.
update
Get the latest
on new Merchant API features, bug fixes, and updates.
add_alert
Note: Content API for Shopping will be sunset on August 18, 2026.
Method: shippingsettings.getsupportedcarriers
Stay organized with collections
Save and categorize content based on your preferences.
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.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-25 UTC.
[null,null,["Last updated 2025-02-25 UTC."],[[["\u003cp\u003eRetrieves the supported shipping carriers and their services for a specific Merchant Center account.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes carrier details such as name, country, supported services, and services eligible for estimated delivery date calculation.\u003c/p\u003e\n"],["\u003cp\u003eThe request is made with an HTTP GET to the URL \u003ccode\u003ehttps://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/supportedCarriers\u003c/code\u003e, replacing \u003ccode\u003e{merchantId}\u003c/code\u003e with the account ID.\u003c/p\u003e\n"],["\u003cp\u003eThe response is a JSON object containing a list of supported carriers, each with details of their services.\u003c/p\u003e\n"]]],["To retrieve supported carriers, send a `GET` request to `https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/supportedCarriers`, ensuring the request body is empty. Replace `{merchantId}` with the target account ID. The response, formatted in JSON, will list supported carriers, including their `name`, `country`, and `services`. The request needs `https://www.googleapis.com/auth/content` authorization scope. Each `carrier` includes `eddServices` field for EDD calculation.\n"],null,["# Method: shippingsettings.getsupportedcarriers\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ShippingsettingsGetSupportedCarriersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [CarriersCarrier](#CarriersCarrier)\n - [JSON representation](#CarriersCarrier.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nRetrieves supported carriers and carrier services for an account.\n\n### HTTP request\n\n`GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/supportedCarriers`\n\n### Path parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------|\n| `merchantId` | `string` The ID of the account for which to retrieve the supported carriers. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"carriers\": [ { object (/shopping-content/reference/rest/v2.1/shippingsettings/getsupportedcarriers#CarriersCarrier) } ] } ``` |\n\n| Fields ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsGetSupportedCarriersResponse`\". |\n| `carriers[]` | `object (`[CarriersCarrier](/shopping-content/reference/rest/v2.1/shippingsettings/getsupportedcarriers#CarriersCarrier)`)` A list of supported carriers. May be empty. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2).\n\nCarriersCarrier\n---------------\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"country\": string, \"services\": [ string ], \"eddServices\": [ string ] } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the carrier (for example, `\"UPS\"`). Always present. |\n| `country` | `string` The CLDR country code of the carrier (for example, \"US\"). Always present. |\n| `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. |\n| `eddServices[]` | `string` A list of services supported for EDD (Estimated Delivery Date) calculation. This is the list of valid values for WarehouseBasedDeliveryTime.carrierService. |"]]