Catalog Batch API - Commerce

Use the Catalog Batch API for these use cases:

  • If you have large catalogs, such as a catalog containing millions of items with quickly changing inventory. You can create, update, and delete multiple items in a single HTTP request.

  • If you need to create and update product information more often than once an hour (otherwise, use the Feed API). You can update multiple items in a single HTTP request.

How it Works

The Catalog Batch API for Commerce consists of the following endpoints:

Endpoint Description Versions Supported See Guide

POST /{catalog_id}/batch

Sends a batch of requests (create, update, delete) for an ecommerce catalog. Used only for product items.

5.0. 4.0, 3.3, 3.2, 3.1 and prior

Send Item Updates

POST /{catalog_id}/items_batch

Sends a batch of requests (create, update, delete) for a catalog. Used for a variety of different objects, such as products, hotels, hotel rooms, flights, destination, home listings, vehicle, and vehicle offers.

5.0, 4.0, 3.3, 3.2

Send Product Updates

GET /{catalog_id}/check_batch_request_status

Checks the status of a batch request. Use a handle (returned from a call to {catalog_id}/batch) and make a GET call.

5.0, 4.0, 3.3, 3.2, 3.1 and prior

Check Batch Request Status

The parameter names for /{catalog_id}/batch and /{catalog_id}/items_batch may appear to be similar, but they are distinctly different.

Next Steps

Use the Catalog Batch API guides to help you perform common actions with the Catalog Batch API.