Home > @vsf-enterprise/bigcommerce-api > ProductOptionValue
# ProductOptionValue interface
Product Option value.
Signature:
export interface ProductOptionValue
# Properties
Property | Type | Description |
---|---|---|
id | number | The unique numeric ID of the value; increments sequentially. |
is_default | boolean | The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. |
label | string | The text display identifying the value on the storefront. Required in a /POST. |
sort_order | number | The order in which the value will be displayed on the product page. Required in a /POST. |
value_data | Record<string, unknown> | 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 of colors , with up to three hexidecimal color keys; or an image_url , which is a full image URL path including protocol. The product list type option requires a product_id . The checkbox type option requires a boolean flag, called checked_value , to determine which value is considered to be the checked state. |