Store Product Variations
Store products can have variation options and product variations to offer different combinations of a product (e.g., different sizes and colours).
- Variation options define the available properties and their possible values (e.g., a "Size" option with values "Small", "Medium", "Large").
- Product variations represent specific combinations of those option values (e.g., "Small / Red") with optional SKU, price override, and stock quantity.
note
Variations must be enabled on the product (variations: true) before you can create variation options or product variations. Enable variations by updating the product via the Update Store Product endpoint.
How Variations Work
- Define variation options -- Create options like "Size" and "Color" with their possible values.
- Create product variations -- Combine option values into specific variations. Each variation can override the base product price and track its own stock quantity.
- Auto-generated names -- Variation names are automatically generated from the option values (e.g., "Small / Red").
API Scopes
| Scope | Description |
|---|---|
store:read | List and retrieve variation options and product variations |
store:write | Create, update, and delete variation options and product variations |
Endpoints
Variation Options
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/store-products/{id}/variation-options | List variation options |
| POST | /v1/store-products/{id}/variation-options | Create a variation option |
| PUT | /v1/store-products/{id}/variation-options/{optionId} | Update a variation option |
| DELETE | /v1/store-products/{id}/variation-options/{optionId} | Delete a variation option |
Product Variations
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/store-products/{id}/variations | List variations |
| GET | /v1/store-products/{id}/variations/{variationId} | Get a variation |
| POST | /v1/store-products/{id}/variations | Create a variation |
| PUT | /v1/store-products/{id}/variations/{variationId} | Update a variation |
| DELETE | /v1/store-products/{id}/variations/{variationId} | Delete a variation |