Method: returnaddress.custombatch

  • 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 ReturnaddressCustomBatchRequest object specifying the individual operations to perform.

  • Each individual operation within the batch is defined by a ReturnaddressCustomBatchRequestEntry object, containing details like the method and the return address data.

  • The response provides a ReturnaddressCustomBatchResponse object containing a list of ReturnaddressCustomBatchResponseEntry objects, each corresponding to an individual operation result.

  • Authorization is required using OAuth 2.0 with the https://www.googleapis.com/auth/content scope.

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 (ReturnaddressCustomBatchResponseEntry)
    }
  ],
  "kind": string
}
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

JSON representation 
{
  "entries": [
    {
      object (ReturnaddressCustomBatchRequestEntry)
    }
  ]
}
Fields
entries[]

object (ReturnaddressCustomBatchRequestEntry)

The request entries to be processed in the batch.

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:

  • "delete"
  • "get"
  • "insert"
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"