Productstatuses: custombatch

Gets the statuses of multiple products in a single request. Try it now.

Request

HTTP request

POST https://www.googleapis.com/content/v2.1/productstatuses/batch

Authorization

This request requires authorization with the following scope:

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,
      "productId": string,
      "includeAttributes": boolean,
      "destinations": [
        string
      ]
    }
  ]
}
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"
entries[].productId string The ID of the product whose status to get.
entries[].includeAttributes boolean
entries[].destinations[] list If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.

Response

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

{
  "kind": "content#productstatusesCustomBatchResponse",
  "entries": [
    {
      "kind": "content#productstatusesCustomBatchResponseEntry",
      "batchId": unsigned integer,
      "productStatus": productstatuses 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#productstatusesCustomBatchResponse".
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#productstatusesCustomBatchResponseEntry".
entries[].batchId unsigned integer The ID of the request entry this entry responds to.
entries[].productStatus nested object The requested product status. Only defined if the request was successful.
entries[].errors nested object A list of errors, 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.

Enviar comentarios sobre…

Content API for Shopping