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: promotions.list
Stay organized with collections
Save and categorize content based on your preferences.
List all promotions from your Merchant Center account.
HTTP request
GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/promotions
Path parameters
| Parameters |
merchantId |
string (int64 format)
Required. The ID of the account that contains the collection.
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
|
pageToken |
string
A page token, received from a previous promotions.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to promotions.list must match the call that provided the page token.
|
countryCode |
string
CLDR country code (for example, "US"), used as a filter on promotions target country.
|
languageCode |
string
The two-letter ISO 639-1 language code associated with the promotions, used as a filter.
|
Request body
The request body must be empty.
Response body
Response message for Promotions.List method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"promotions": [
{
object (Promotion)
}
],
"nextPageToken": string
} |
| Fields |
promotions[] |
object (Promotion)
List of all available promotions for the merchant.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
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 all promotions from a specified Merchant Center account using the \u003ccode\u003epromotions.list\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by country code, language, page size, and provides pagination with page tokens for retrieving large result sets.\u003c/p\u003e\n"],["\u003cp\u003eRequest body should be empty, and successful responses contain a list of \u003ccode\u003ePromotion\u003c/code\u003e objects and a \u003ccode\u003enextPageToken\u003c/code\u003e if applicable.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document outlines how to list promotions from a Merchant Center account using an HTTP GET request. The request URL includes a `merchantId` path parameter. Optional query parameters include `pageSize`, `pageToken`, `countryCode`, and `languageCode` for filtering and pagination. The request body is empty. The successful response contains a list of `promotions` and a `nextPageToken` for further pagination. The process requires OAuth 2.0 authorization with the `https://www.googleapis.com/auth/content` scope.\n"],null,["# Method: promotions.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.ListPromotionResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nList all promotions from your Merchant Center account.\n\n### HTTP request\n\n`GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/promotions`\n\n### Path parameters\n\n| Parameters ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `merchantId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the account that contains the collection. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |\n| `pageToken` | `string` A page token, received from a previous `promotions.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `promotions.list` must match the call that provided the page token. |\n| `countryCode` | `string` [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, \"US\"), used as a filter on promotions target country. |\n| `languageCode` | `string` The two-letter ISO 639-1 language code associated with the promotions, used as a filter. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for Promotions.List method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"promotions\": [ { object (/shopping-content/reference/rest/v2.1/promotions#Promotion) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| `promotions[]` | `object (`[Promotion](/shopping-content/reference/rest/v2.1/promotions#Promotion)`)` List of all available promotions for the merchant. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\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)."]]