Method: shippingsettings.custombatch

  • This operation retrieves and updates the shipping settings of multiple accounts through a single HTTP POST request.

  • The request body must contain a ShippingsettingsCustomBatchRequest object, specifying the desired actions for each account.

  • If successful, the response provides a ShippingsettingsCustomBatchResponse containing the results for each individual account request, including updated shipping settings or errors.

  • The process utilizes the https://www.googleapis.com/auth/content OAuth scope for authorization.

  • Developers can find details about request and response structures, including JSON representations, for each component involved in the batch operation.

Retrieves and updates the shipping settings of multiple accounts in a single request.

HTTP request

POST https://shoppingcontent.googleapis.com/content/v2.1/shippingsettings/batch

Request body

The request body contains an instance of ShippingsettingsCustomBatchRequest.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "entries": [
    {
      object (ShippingsettingsCustomBatchResponseEntry)
    }
  ],
  "kind": string
}
Fields
entries[]

object (ShippingsettingsCustomBatchResponseEntry)

The result of the execution of the batch requests.
kind

string

Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse".

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

ShippingsettingsCustomBatchRequest

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

object (ShippingsettingsCustomBatchRequestEntry)

The request entries to be processed in the batch.

ShippingsettingsCustomBatchRequestEntry

A batch entry encoding a single non-batch shippingsettings request.

JSON representation 
{
  "batchId": integer,
  "merchantId": string,
  "method": string,
  "accountId": string,
  "shippingSettings": {
    object (ShippingSettings)
  }
}
Fields
batchId

integer (uint32 format)

An entry ID, unique within the batch request.
merchantId

string

The ID of the managing account.
method

string

The method of the batch entry.

Acceptable values are:

  • "get"
  • "update"
accountId

string

The ID of the account for which to get/update account shipping settings.
shippingSettings

object (ShippingSettings)

The account shipping settings to update. Only defined if the method is update.

ShippingsettingsCustomBatchResponseEntry

A batch entry encoding a single non-batch shipping settings response.

JSON representation 
{
  "batchId": integer,
  "shippingSettings": {
    object (ShippingSettings)
  },
  "kind": string,
  "errors": {
    object (Errors)
  }
}
Fields
batchId

integer (uint32 format)

The ID of the request entry to which this entry responds.
shippingSettings

object (ShippingSettings)

The retrieved or updated account shipping settings.
kind

string

Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponseEntry"
errors

object (Errors)

A list of errors for failed custombatch entries.