Beta
The Product Catalog is currently in Beta and is not yet available to all customers. Availability is being expanded gradually. Functionality, configuration, and behavior may change before general availability.
The Product Catalog API allows you to manage product catalog data programmatically. Use this API to retrieve, create, update, and delete product variant data in a catalog.
The API supports operations for individual variants as well as bulk operations for processing multiple variants in one request.
Looking for Product Catalog setup and configuration guidance?
See the Product Catalog documentation for information about catalogs, attributes, feed management, and user interface workflows.
What you can do with this API
Use the Product Catalog API to:
Retrieve a single variant by its variant ID.
List all variants associated with a product.
Create new variants.
Add missing data to existing variants.
Fully replace existing variant data.
Partially update selected variant attributes.
Delete variants or selected variant attributes.
Process multiple variants with bulk operations.
Main concepts
Company
A company is identified by companyId. All API requests are scoped to a specific company.
Catalog
A catalog is identified by catalogId. Product and variant data is managed inside a catalog.
Product
A product represents a logical product entity. A product can have one or more variants.
Variant
A variant represents an individual catalog item identified by variantId.
For example, a T-shirt can be represented as a product, while the specific combinations of color and size are variants of that product.
Single and bulk operations
The API supports both single-variant operations and bulk operations.
Operation type | Use case |
|---|---|
Single-variant operations | Use these operations to retrieve, create, update, or delete one variant at a time. |
Bulk operations | Use these operations to process multiple variants in one request. |
Data management behavior
The API provides different methods for managing variant data.
Method | Behavior |
|---|---|
| Retrieves product or variant data. |
| Adds new variant data or adds missing data to an existing variant. |
| Creates a variant or fully replaces an existing variant. |
| Updates selected fields of an existing variant. |
| Deletes variants or selected variant attributes. |