Catalog Batch API

This guide describes how to use the Catalog Batch API:

  • For Advantage+ catalog ads catalogs — Use this API 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.

  • For commerce catalogs — Use this API to update product information. You can update multiple items in a single HTTP request.

How it Works

Use the Catalog Batch API 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.

The Catalog Batch API consists of the following endpoints:

Endpoint Description In This Guide

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.

Supports all MAPI versions up to 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}/items_batch) and make a GET call.

Supports all MAPI versions, prior to 3.1.

Check Batch Request Status

POST /{catalog_id}/localized_items_batch

Sends batch localization requests to existing catalog items in your catalog. The batch can contain (create, update, delete) localization requests. This endpoint can be used for a variety of different objects, such as products, hotels, flights, destination, home listings, vehicle.

Supports all MAPI versions, prior to 3.1.

Send Localized Items Batch

Next Steps

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

Learn More