[null,null,["Last updated 2025-02-25 UTC."],[[["\u003cp\u003eUse this batch service to retrieve the statuses of multiple products in a single request.\u003c/p\u003e\n"],["\u003cp\u003eThe request body utilizes \u003ccode\u003eProductstatusesCustomBatchRequest\u003c/code\u003e containing individual product requests.\u003c/p\u003e\n"],["\u003cp\u003eThe response body includes an array of \u003ccode\u003eProductstatusesCustomBatchResponseEntry\u003c/code\u003e, each detailing a product's status.\u003c/p\u003e\n"],["\u003cp\u003eThis service requires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This content outlines a process to retrieve multiple product statuses via a batch request. Using a `POST` request to the provided endpoint, you send a `ProductstatusesCustomBatchRequest` with multiple `ProductstatusesCustomBatchRequestEntry`. Each entry requires a unique `batchId`, `merchantId`, and `productId`. The response, a `ProductstatusesCustomBatchResponse`, contains `ProductstatusesCustomBatchResponseEntry`, including product status or errors for each request, identified by its corresponding `batchId`. Authorization requires specific OAuth scopes.\n"],null,["# Method: productstatuses.custombatch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ProductstatusesCustomBatchResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [ProductstatusesCustomBatchRequest](#ProductstatusesCustomBatchRequest)\n - [JSON representation](#ProductstatusesCustomBatchRequest.SCHEMA_REPRESENTATION)\n- [ProductstatusesCustomBatchRequestEntry](#ProductstatusesCustomBatchRequestEntry)\n - [JSON representation](#ProductstatusesCustomBatchRequestEntry.SCHEMA_REPRESENTATION)\n- [ProductstatusesCustomBatchResponseEntry](#ProductstatusesCustomBatchResponseEntry)\n - [JSON representation](#ProductstatusesCustomBatchResponseEntry.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nGets the statuses of multiple products in a single request.\n\n### HTTP request\n\n`POST https://shoppingcontent.googleapis.com/content/v2.1/productstatuses/batch`\n\n### Request body\n\nThe request body contains an instance of [ProductstatusesCustomBatchRequest](/shopping-content/reference/rest/v2.1/productstatuses/custombatch#ProductstatusesCustomBatchRequest).\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"entries\": [ { object (/shopping-content/reference/rest/v2.1/productstatuses/custombatch#ProductstatusesCustomBatchResponseEntry) } ], \"kind\": string } ``` |\n\n| Fields ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `entries[]` | `object (`[ProductstatusesCustomBatchResponseEntry](/shopping-content/reference/rest/v2.1/productstatuses/custombatch#ProductstatusesCustomBatchResponseEntry)`)` The result of the execution of the batch requests. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string \"`content#productstatusesCustomBatchResponse`\". |\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\nProductstatusesCustomBatchRequest\n---------------------------------\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"entries\": [ { object (/shopping-content/reference/rest/v2.1/productstatuses/custombatch#ProductstatusesCustomBatchRequestEntry) } ] } ``` |\n\n| Fields ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `entries[]` | `object (`[ProductstatusesCustomBatchRequestEntry](/shopping-content/reference/rest/v2.1/productstatuses/custombatch#ProductstatusesCustomBatchRequestEntry)`)` The request entries to be processed in the batch. |\n\nProductstatusesCustomBatchRequestEntry\n--------------------------------------\n\nA batch entry encoding a single non-batch productstatuses request.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"batchId\": integer, \"merchantId\": string, \"method\": string, \"productId\": string, \"includeAttributes\": boolean, \"destinations\": [ string ] } ``` |\n\n| Fields ||\n|--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|\n| `batchId` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` An entry ID, unique within the batch request. |\n| `merchantId` | `string` The ID of the managing account. |\n| `method` | `string` The method of the batch entry. Acceptable values are: - \"`get`\" \u003cbr /\u003e |\n| `productId` | `string` The ID of the product whose status to get. |\n| `includeAttributes` **(deprecated)** | `boolean` | This item is deprecated! Deprecated: Setting this field has no effect and attributes are never included. |\n| `destinations[]` | `string` If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination. |\n\nProductstatusesCustomBatchResponseEntry\n---------------------------------------\n\nA batch entry encoding a single non-batch productstatuses response.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"batchId\": integer, \"kind\": string, \"productStatus\": { object (/shopping-content/reference/rest/v2.1/productstatuses#ProductStatus) }, \"errors\": { object (/shopping-content/reference/rest/v2.1/Errors) } } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `batchId` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the request entry this entry responds to. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string \"`content#productstatusesCustomBatchResponseEntry`\" |\n| `productStatus` | `object (`[ProductStatus](/shopping-content/reference/rest/v2.1/productstatuses#ProductStatus)`)` The requested product status. Only defined if the request was successful. |\n| `errors` | `object (`[Errors](/shopping-content/reference/rest/v2.1/Errors)`)` A list of errors for failed custombatch entries. | **Note:** Schema errors fail the whole request. \u003cbr /\u003e |"]]