The Product Catalog API provides multiple ways to manage variant data. The behavior depends on the HTTP method used.
Single and bulk operations
The API supports operations for individual variants as well as bulk processing.
Operation type | Purpose |
|---|---|
Single operations | Manage individual variants one at a time. |
Bulk operations | Process multiple variants in a single request. |
Behavior by HTTP method
Method | Behavior |
|---|---|
| Retrieves product or variant information. |
| Adds new variant data or enriches existing variants with missing data. |
| Creates a variant or fully replaces existing variant data. |
| Updates only the provided fields of an existing variant. |
| Deletes variants or selected variant attributes. |
Active status filtering
Some endpoints support filtering through the activeStatusSearch parameter.
The following values are supported:
ACTIVE_ONLY- Returns only attributes whereisActiveistrue.INACTIVE_ONLY- Returns only attributes whereisActiveisfalse.ALL- Returns all attributes regardless of theisActivevalue.
If the parameter is not provided, the behavior is equivalent to ALL.
Note
This filter applies to attribute status (isActive) and not to product or variant lifecycle status.
Bulk processing behavior
Bulk operations allow up to 1000 variant events in a single request.
Bulk processing is not transactional.
Each variant event is validated and processed independently.
A failure in one variant event does not prevent other variant events from being processed successfully.
Bulk operation responses contain separate lists for successful and failed events:
variant_events_success: Variant events that passed validation.
variant_events_failed: Variant events that failed validation.
No official retry recommendation is currently defined.
Bulk operation responses
Bulk operation responses contain separate lists for successful and failed events.
Response field | Description |
|---|---|
| Variant events that passed validation and processing. |
| Variant events that failed validation or processing. |
Request limits
Limit | Value |
|---|---|
Maximum variants per request | 1000 |
Maximum payload size | No explicit limit defined |
Retry behavior
No official retry recommendation is currently defined.