AI-generated Key Takeaways
-
This operation batches multiple return address related calls, such as get, insert, and delete, in a single request to the Shopping Content API.
-
The request body must contain a
ReturnaddressCustomBatchRequestobject specifying the individual operations to perform. -
Each individual operation within the batch is defined by a
ReturnaddressCustomBatchRequestEntryobject, containing details like the method and the return address data. -
The response provides a
ReturnaddressCustomBatchResponseobject containing a list ofReturnaddressCustomBatchResponseEntryobjects, each corresponding to an individual operation result. -
Authorization is required using OAuth 2.0 with the
https://www.googleapis.com/auth/contentscope.
- HTTP request
- Request body
- Response body
- Authorization scopes
- ReturnaddressCustomBatchRequest
- ReturnaddressCustomBatchRequestEntry
- ReturnaddressCustomBatchResponseEntry
- Try it!
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:
| JSON representation |
|---|
{
"entries": [
{
object ( |
| Fields | |
|---|---|
entries[] |
The result of the execution of the batch requests. |
kind |
Identifies what kind of resource this is. Value: the fixed string " |
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
| JSON representation |
|---|
{
"entries": [
{
object ( |
| Fields | |
|---|---|
entries[] |
The request entries to be processed in the batch. |
ReturnaddressCustomBatchRequestEntry
| JSON representation |
|---|
{
"batchId": integer,
"merchantId": string,
"method": string,
"returnAddressId": string,
"returnAddress": {
object ( |
| Fields | |
|---|---|
batchId |
An entry ID, unique within the batch request. |
merchantId |
The Merchant Center account ID. |
method |
Method of the batch request entry. Acceptable values are:
|
returnAddressId |
The return address ID. This should be set only if the method is |
returnAddress |
The return address to submit. This should be set only if the method is |
ReturnaddressCustomBatchResponseEntry
| JSON representation |
|---|
{ "batchId": integer, "returnAddress": { object ( |
| Fields | |
|---|---|
batchId |
The ID of the request entry to which this entry responds. |
returnAddress |
The retrieved return address. |
errors |
A list of errors defined if, and only if, the request failed. |
kind |
Identifies what kind of resource this is. Value: the fixed string " |