Values
Get all product modifier values
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/modifiers/{modifier_id}/valuesRequest
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- product_id in path - integerrequired
The ID of the product to which the resource belongs.
- modifier_id in path - integerrequired
The ID of the product modifier.
- include_fields in query - arrayFields to include, in a comma-separated list. The ID and the specified fields will be returned.Type: array[string]
- exclude_fields in query - arrayFields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.Type: array[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.
example
Response
Body
dataarray[object]
example
Create product modifier value
POST https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/modifiers/{modifier_id}/valuesRequest
Creates a modifier value.
Required Fields
- label
- sort_order
Read-Only Fields
- id
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- product_id in path - integerrequired
The ID of the product to which the resource belongs.
- modifier_id in path - integerrequired
The ID of the product modifier.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
is_defaultboolean
The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
labelstring
requiredThe text display identifying the value on the storefront. Required in a /POST.
Example: Greensort_orderinteger
requiredThe order in which the value will be displayed on the product page. Required in a /POST.
Min: -2147483648Max: 2147483647value_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 hexadecimal 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.adjustersobject
example
Response
Body
dataobject
Part of Modifier Value Response
example
Get a product modifier value
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}Request
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- product_id in path - integerrequired
The ID of the product to which the resource belongs.
- modifier_id in path - integerrequired
The ID of the product modifier.
- value_id in path - integerrequired
The ID of the product modifier value.
- include_fields in query - arrayFields to include, in a comma-separated list. The ID and the specified fields will be returned.Type: array[string]
- exclude_fields in query - arrayFields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.Type: array[string]
example
Response
Body
dataobject
Product modifieroption_value
.
example
Update a product modifier value
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}Request
Updates a modifier value.
Required Fields
- none
Read-Only Fields
- id
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- product_id in path - integerrequired
The ID of the product to which the resource belongs.
- modifier_id in path - integerrequired
The ID of the product modifier.
- value_id in path - integerrequired
The ID of the product modifier value.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
is_defaultboolean
The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.
labelstring
requiredThe text display identifying the value on the storefront. Required in a /POST.
Example: Greensort_orderinteger
requiredThe order in which the value will be displayed on the product page. Required in a /POST.
Min: -2147483648Max: 2147483647value_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 hexadecimal 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.adjustersobject
idinteger
The unique numeric ID of the value; increments sequentially.
example
Response
Body
dataobject
Part of Modifier Value Response
example
Delete product modifier value
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}Request
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- product_id in path - integerrequired
The ID of the product to which the resource belongs.
- modifier_id in path - integerrequired
The ID of the product modifier.
- value_id in path - integerrequired
The ID of the product modifier value.