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: collectionstatuses.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the statuses of the collections in your Merchant Center account.
HTTP request
GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/collectionstatuses
Path parameters
| Parameters |
merchantId |
string (int64 format)
Required. The ID of the account that contains the collection. This account cannot be a multi-client account.
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of collection statuses to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.
|
pageToken |
string
Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response message for the collectionstatuses.list method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"resources": [
{
object (CollectionStatus)
}
],
"nextPageToken": string
} |
| Fields |
resources[] |
object (CollectionStatus)
The collectionstatuses listed.
|
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 the statuses of the collections in your Merchant Center account.\u003c/p\u003e\n"],["\u003cp\u003eUses the \u003ccode\u003eGET\u003c/code\u003e method and requires the Merchant Center account ID as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eAllows optional pagination using \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of collection statuses and a token for retrieving subsequent pages, if available.\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 details how to retrieve collection statuses from a Merchant Center account. Use a `GET` request to `https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/collectionstatuses`, replacing `{merchantId}` with the account ID. The request body must be empty. Optional query parameters `pageSize` and `pageToken` control pagination. The response includes a list of `CollectionStatus` objects and a `nextPageToken` for subsequent pages. Access requires the `https://www.googleapis.com/auth/content` authorization scope.\n"],null,["# Method: collectionstatuses.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.ListCollectionStatusesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the statuses of the collections in your Merchant Center account.\n\n### HTTP request\n\n`GET https://shoppingcontent.googleapis.com/content/v2.1/{merchantId}/collectionstatuses`\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. This account cannot be a multi-client account. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of collection statuses to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000. |\n| `pageToken` | `string` Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for the collectionstatuses.list method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"resources\": [ { object (/shopping-content/reference/rest/v2.1/collectionstatuses#CollectionStatus) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------|\n| `resources[]` | `object (`[CollectionStatus](/shopping-content/reference/rest/v2.1/collectionstatuses#CollectionStatus)`)` The collectionstatuses listed. |\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)."]]