Products: custombatch

Retrieves, inserts, and deletes multiple products in a single request. Try it now.

Request

HTTP request

POST https://www.googleapis.com/content/v2.1/products/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,
      "product": products Resource,
      "feedId": unsigned long
    }
  ]
}
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:
  • "delete"
  • "get"
  • "insert"
entries[].productId string The ID of the product to get or delete. Only defined if the method is get or delete.
entries[].product nested object The product to insert. Only required if the method is insert.
entries[].feedId unsigned long The Content API feed id.

Response

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

{
  "kind": "content#productsCustomBatchResponse",
  "entries": [
    {
      "kind": "content#productsCustomBatchResponseEntry",
      "batchId": unsigned integer,
      "product": products 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#productsCustomBatchResponse".
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#productsCustomBatchResponseEntry".
entries[].batchId unsigned integer The ID of the request entry this entry responds to.
entries[].product nested object The inserted product. Only defined if the method is insert and if the request was successful.
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