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: returnaddress.custombatch
Stay organized with collections
Save and categorize content based on your preferences.
Batches multiple return address related calls in a single request.
HTTP request
POST https://shoppingcontent.googleapis.com/content/v2.1/returnaddress/batch
Request body
The request body contains an instance of ReturnaddressCustomBatchRequest
.
Response body
If successful, the response body contains data with the following structure:
Fields |
entries[] |
object (ReturnaddressCustomBatchResponseEntry )
The result of the execution of the batch requests.
|
kind |
string
Identifies what kind of resource this is. Value: the fixed string "content#returnaddressCustomBatchResponse ".
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/content
For more information, see the OAuth 2.0 Overview.
ReturnaddressCustomBatchRequest
ReturnaddressCustomBatchRequestEntry
JSON representation |
{
"batchId": integer,
"merchantId": string,
"method": string,
"returnAddressId": string,
"returnAddress": {
object (ReturnAddress )
}
} |
Fields |
batchId |
integer (uint32 format)
An entry ID, unique within the batch request.
|
merchantId |
string
The Merchant Center account ID.
|
method |
string
Method of the batch request entry. Acceptable values are:
|
returnAddressId |
string
The return address ID. This should be set only if the method is delete or get .
|
returnAddress |
object (ReturnAddress )
The return address to submit. This should be set only if the method is insert .
|
ReturnaddressCustomBatchResponseEntry
JSON representation |
{
"batchId": integer,
"returnAddress": {
object (ReturnAddress )
},
"errors": {
object (Errors )
},
"kind": string
} |
Fields |
batchId |
integer (uint32 format)
The ID of the request entry to which this entry responds.
|
returnAddress |
object (ReturnAddress )
The retrieved return address.
|
errors |
object (Errors )
A list of errors defined if, and only if, the request failed.
|
kind |
string
Identifies what kind of resource this is. Value: the fixed string "content#returnaddressCustomBatchResponseEntry "
|
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\u003eThis operation batches multiple return address related calls, such as get, insert, and delete, in a single request to the Shopping Content API.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must contain a \u003ccode\u003eReturnaddressCustomBatchRequest\u003c/code\u003e object specifying the individual operations to perform.\u003c/p\u003e\n"],["\u003cp\u003eEach individual operation within the batch is defined by a \u003ccode\u003eReturnaddressCustomBatchRequestEntry\u003c/code\u003e object, containing details like the method and the return address data.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides a \u003ccode\u003eReturnaddressCustomBatchResponse\u003c/code\u003e object containing a list of \u003ccode\u003eReturnaddressCustomBatchResponseEntry\u003c/code\u003e objects, each corresponding to an individual operation result.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using OAuth 2.0 with the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This content outlines how to batch multiple return address operations via a single HTTP POST request to `https://shoppingcontent.googleapis.com/content/v2.1/returnaddress/batch`. The request body, `ReturnaddressCustomBatchRequest`, contains an array of `ReturnaddressCustomBatchRequestEntry` objects, each defining a single action (`delete`, `get`, or `insert`). The response body, `ReturnaddressCustomBatchResponse`, contains an array of `ReturnaddressCustomBatchResponseEntry` objects, reflecting the outcome of each request entry. Authorization requires the `https://www.googleapis.com/auth/content` scope.\n"],null,["# Method: returnaddress.custombatch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ReturnaddressCustomBatchResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [ReturnaddressCustomBatchRequest](#ReturnaddressCustomBatchRequest)\n - [JSON representation](#ReturnaddressCustomBatchRequest.SCHEMA_REPRESENTATION)\n- [ReturnaddressCustomBatchRequestEntry](#ReturnaddressCustomBatchRequestEntry)\n - [JSON representation](#ReturnaddressCustomBatchRequestEntry.SCHEMA_REPRESENTATION)\n- [ReturnaddressCustomBatchResponseEntry](#ReturnaddressCustomBatchResponseEntry)\n - [JSON representation](#ReturnaddressCustomBatchResponseEntry.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nBatches multiple return address related calls in a single request.\n\n### HTTP request\n\n`POST https://shoppingcontent.googleapis.com/content/v2.1/returnaddress/batch`\n\n### Request body\n\nThe request body contains an instance of [ReturnaddressCustomBatchRequest](/shopping-content/reference/rest/v2.1/returnaddress/custombatch#ReturnaddressCustomBatchRequest).\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/returnaddress/custombatch#ReturnaddressCustomBatchResponseEntry) } ], \"kind\": string } ``` |\n\n| Fields ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `entries[]` | `object (`[ReturnaddressCustomBatchResponseEntry](/shopping-content/reference/rest/v2.1/returnaddress/custombatch#ReturnaddressCustomBatchResponseEntry)`)` The result of the execution of the batch requests. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string \"`content#returnaddressCustomBatchResponse`\". |\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\nReturnaddressCustomBatchRequest\n-------------------------------\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"entries\": [ { object (/shopping-content/reference/rest/v2.1/returnaddress/custombatch#ReturnaddressCustomBatchRequestEntry) } ] } ``` |\n\n| Fields ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `entries[]` | `object (`[ReturnaddressCustomBatchRequestEntry](/shopping-content/reference/rest/v2.1/returnaddress/custombatch#ReturnaddressCustomBatchRequestEntry)`)` The request entries to be processed in the batch. |\n\nReturnaddressCustomBatchRequestEntry\n------------------------------------\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"batchId\": integer, \"merchantId\": string, \"method\": string, \"returnAddressId\": string, \"returnAddress\": { object (/shopping-content/reference/rest/v2.1/returnaddress#ReturnAddress) } } ``` |\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 Merchant Center account ID. |\n| `method` | `string` Method of the batch request entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" \u003cbr /\u003e |\n| `returnAddressId` | `string` The return address ID. This should be set only if the method is `delete` or `get`. |\n| `returnAddress` | `object (`[ReturnAddress](/shopping-content/reference/rest/v2.1/returnaddress#ReturnAddress)`)` The return address to submit. This should be set only if the method is `insert`. |\n\nReturnaddressCustomBatchResponseEntry\n-------------------------------------\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"batchId\": integer, \"returnAddress\": { object (/shopping-content/reference/rest/v2.1/returnaddress#ReturnAddress) }, \"errors\": { object (/shopping-content/reference/rest/v2.1/Errors) }, \"kind\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `batchId` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the request entry to which this entry responds. |\n| `returnAddress` | `object (`[ReturnAddress](/shopping-content/reference/rest/v2.1/returnaddress#ReturnAddress)`)` The retrieved return address. |\n| `errors` | `object (`[Errors](/shopping-content/reference/rest/v2.1/Errors)`)` A list of errors defined if, and only if, the request failed. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string \"`content#returnaddressCustomBatchResponseEntry`\" |"]]