Shippingsettings: custombatch

Requires authorization

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

Request

HTTP request

POST https://www.googleapis.com/content/v2/shippingsettings/batch

Parameters

Parameter name Value Description
Optional query parameters
dryRun boolean Flag to run the request in dry-run mode.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

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

Request body

In the request body, supply data with the following structure:

{
  "entries": [
    {
      "batchId": unsigned integer,
      "merchantId": unsigned long,
      "method": string,
      "accountId": unsigned long,
      "shippingSettings": shippingsettings Resource
    }
  ]
}
Property name Value Description Notes
entries[] list The request entries to be processed in the batch.
entries[].batchId unsigned integer An entry ID, unique within the batch request.
entries[].merchantId unsigned long The ID of the managing account.
entries[].method string

Acceptable values are:
  • "get"
  • "update"
entries[].accountId unsigned long The ID of the account for which to get/update account shipping settings.
entries[].shippingSettings nested object The account shipping settings to update. Only defined if the method is update.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "content#shippingsettingsCustomBatchResponse",
  "entries": [
    {
      "kind": "content#shippingsettingsCustomBatchResponseEntry",
      "batchId": unsigned integer,
      "shippingSettings": shippingsettings Resource,
      "errors": {
        "errors": [
          {
            "domain": string,
            "reason": string,
            "message": string
          }
        ],
        "code": unsigned integer,
        "message": string
      }
    }
  ]
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponse".
entries[] list The result of the execution of the batch requests.
entries[].kind string Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponseEntry".
entries[].batchId unsigned integer The ID of the request entry to which this entry responds.
entries[].shippingSettings nested object The retrieved or updated account shipping settings.
entries[].errors nested object A list of errors defined if, and only if, the request failed.
entries[].errors.errors[] list A list of errors.
entries[].errors.errors[].domain string The domain of the error.
entries[].errors.errors[].reason string The error code.
entries[].errors.errors[].message string A description of the error.
entries[].errors.code unsigned integer The HTTP status of the first error in errors.
entries[].errors.message string The message of the first error in errors.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Send feedback about...

Content API for Shopping