Method: returnaddress.custombatch

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 "

Design a Mobile Site
View Site in Mobile | Classic
Share by: