Catalog - Product variant options
The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the Catalog overview.
Product variant options represent the different facets of a product. For example, size, color, fabric. Variant option values are the actual sizes, colors, fabrics, that are available. Product variants consist of combinations of variant option values.
The following table illustrates the relationship between variant options and variant option values using a line of signature sneakers as an example.
Variant options | Variant option values | No. of variants |
---|---|---|
size (US Women's) | 6, 6.5, 7, 7.5, 8, 8.5, 9, 9.5, 10, 10.5 | 10 |
upper material | canvas, marine plastic, leather | 3 |
upper color | brick, azul, gold | 3 |
sole color | charcoal, white, azul | 3 |
270 |
Our Catalog product variant options endpoints let you work with both variant options and variant option values.
To learn more about authenticating Catalog endpoints, locate the Authentication section at the top of each endpoint, then click Show Details.
Resources
Webhooks
Learn more about Product webhook events.
Additional Catalog endpoints
Get All Product Variant Options
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/optionsRequest
Returns a list of product Variant Options. Optional parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
Get all product options
dataarray[]
example
Create a Product Variant Option
POST https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/optionsRequest
Creates a Variant Option.
Required Fields
- display_name
- type
- option_values
Read-Only Fields
- id
Limits
- 255 characters option name length.
Notes
- Only one variant option at a time can be created; individual variant options will contain an array of multiple values.
- There are several examples listed below that create options, but the SKUs are not updated and they are not a variant on the product. Variant SKUs must be created with a separate request.
- Variant options will show on the storefront as an option that can be selected by the customer. A request like this could be used to add new choices to a variant that has already been created.
- If more than one variant needs to be created, use the Create a Product endpoint.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
The model for a POST to create options on a product.
example
Response
Body
data
example-1
example-2
Get a Product Variant Option
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/options/{option_id}Request
Returns a single Variant Option. Optional parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
data
example
Update a Product Variant Option
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/options/{option_id}Request
Updates a Variant Option.
Read-Only Fields
- id
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
The model for a PUT to update options on a product.
example
Response
Body
data