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.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the shipping settings of the sub-accounts in your Merchant Center account.
HTTP request
GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/shippingsettings
Path parameters
| Parameters |
merchantId |
string
The ID of the managing account. This must be a multi-client account.
|
Query parameters
| Parameters |
maxResults |
integer (uint32 format)
The maximum number of shipping settings to return in the response, used for paging.
|
pageToken |
string
The token returned by the previous request.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"nextPageToken": string,
"kind": string,
"resources": [
{
object (ShippingSettings)
}
]
} |
| Fields |
nextPageToken |
string
The token for the retrieval of the next page of shipping settings.
|
kind |
string
Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse".
|
resources[] |
object (ShippingSettings)
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
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\u003eLists the shipping settings for sub-accounts within a 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\u003eUses a GET request to the specified endpoint with optional query parameters for paging.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of shipping settings and a token for retrieving further pages.\u003c/p\u003e\n"],["\u003cp\u003eRequest body should be empty.\u003c/p\u003e\n"]]],["This outlines how to retrieve shipping settings for sub-accounts in a Merchant Center account using a GET request. The URL requires the managing account's ID as a path parameter. Optional query parameters, `maxResults` and `pageToken`, allow for paginated results. The request body must be empty. A successful response includes a `nextPageToken`, a `kind` field, and an array of shipping settings resources. It needs OAuth scope `https://www.googleapis.com/auth/content`.\n"],null,["# Method: shippingsettings.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ShippingsettingsListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the shipping settings of the sub-accounts in your Merchant Center account.\n\n### HTTP request\n\n`GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/shippingsettings`\n\n### Path parameters\n\n| Parameters ||\n|--------------|-------------------------------------------------------------------------------|\n| `merchantId` | `string` The ID of the managing account. This must be a multi-client account. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `maxResults` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` The maximum number of shipping settings to return in the response, used for paging. |\n| `pageToken` | `string` The token returned by the previous request. |\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| ``` { \"nextPageToken\": string, \"kind\": string, \"resources\": [ { object (/shopping-content/reference/rest/v2.1/shippingsettings#ShippingSettings) } ] } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------|\n| `nextPageToken` | `string` The token for the retrieval of the next page of shipping settings. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsListResponse`\". |\n| `resources[]` | `object (`[ShippingSettings](/shopping-content/reference/rest/v2.1/shippingsettings#ShippingSettings)`)` |\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)."]]