Catalog - Product variant options
Get All Product Variant Option Values
GET /stores/{store_hash}/v3/catalog/products/{product_id}/options/{option_id}/values
Request
Returns a list of all Variant Option Values. Optional parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- page in query - integer
Specifies the page number in a limited (paginated) list of products.
- limit in query with default of 50 - integer
Controls the number of items per page in a limited (paginated) list of products.
- include_fields in query - array
Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
- exclude_fields in query - array
Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
example
Response
Body
Get Option Values response.
dataarray[object]
metaobject
Data about the response, including pagination and collection totals.
example
Create a Product Variant Option Value
POST /stores/{store_hash}/v3/catalog/products/{product_id}/options/{option_id}/values
Request
Creates a Variant Option Value.
Required Fields
- label
- sort_order
Read-Only Fields
- id
Limits
- 250 option values per option limit.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
The model for a POST to create option values on a product.
is_defaultboolean
The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
Example: false
labelstring
requiredThe text display identifying the value on the storefront. Required in a /POST.
Example: Green
sort_orderinteger
requiredThe order in which the value will be displayed on the product page. Required in a /POST.
Example: 0
value_dataobject
Extra data describing the value, based on the type of option or modifier with which the value is associated. The
swatch
type option can accept an array ofcolors
, with up to three hexidecimal color keys; or animage_url
, which is a full image URL path including protocol. Theproduct list
type option requires aproduct_id
. Thecheckbox
type option requires a boolean flag, calledchecked_value
, to determine which value is considered to be the checked state.
example
Response
Body
dataobject
metaobject
Response metadata.
example
Get a Product Variant Option Value
GET /stores/{store_hash}/v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}
Request
Returns a single Variant Option Value. Optional parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- include_fields in query - array
Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
- exclude_fields in query - array
Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
example
Response
Body
dataobject
metaobject
Response metadata.
example
Update a Product Variant Option Value
PUT /stores/{store_hash}/v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}
Request
Updates a Variant Option Value.
Read-Only Fields
- id
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
A BigCommerce OptionValue
object.
Body
The model for a PUT to update option values on a product.
is_defaultboolean
The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
Example: false
labelstring
requiredThe text display identifying the value on the storefront. Required in a /POST.
Example: Green
sort_orderinteger
requiredThe order in which the value will be displayed on the product page. Required in a /POST.
Example: 0
value_dataobject
Extra data describing the value, based on the type of option or modifier with which the value is associated. The
swatch
type option can accept an array ofcolors
, with up to three hexidecimal color keys; or animage_url
, which is a full image URL path including protocol. Theproduct list
type option requires aproduct_id
. Thecheckbox
type option requires a boolean flag, calledchecked_value
, to determine which value is considered to be the checked state.
idinteger
The unique numeric ID of the value; increments sequentially.
example
Response
Body
dataobject
metaobject
Response metadata.
example
Delete a Product Variant Option Value
DELETE /stores/{store_hash}/v3/catalog/products/{product_id}/options/{option_id}/values/{value_id}
Request
Deletes a Variant Option Value.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- product_id in path - integerrequired
The ID of the
Product
to which the resource belongs. - option_id in path - integerrequired
The ID of the
Option
. - value_id in path - integerrequired
The ID of the
Modifier/Option Value
.