Catalog - Product modifiers
The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the Catalog Overview.
Product modifiers represent choices that the shopper can make to change how the merchant customizes or adds on to the product. Examples include shipping insurance, monograms, custom inseam length, and color selections for unfinished products.
Modifier values do not change which item is picked in a warehouse, but they change what happens to that item between the warehouse shelf and the shopper taking possession of their order.
Critically, modifier values do not change which product variant is fulfilled. You cannot track inventory for combinations of modifier values.
You can add an adjuster to a modifier value to override the underlying product variant's properties, such as price, weight, and shipping rules. Not all modifier types are compatible with adjusters.
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 modifiers
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/modifiersRequest
Returns a list of all product modifiers. Optional parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
Modifier Collection Response return for /GET All Modifiers.
dataarray[]
example
Create a product modifier
POST https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/modifiersRequest
Creates a product modifier.
Required Fields
requireddisplay_nametype
Read-Only Fields
id
Notes It takes two separate requests to create a new checkbox modifier with option values. Perform a request to create a modifier, then perform a second request to update option values.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
Common Modifier properties.
typestring
requiredBigCommerce API, which determines how it will display on the storefront. Acceptable values:
date,checkbox,file,text,multi_line_text,numbers_only_text,radio_buttons,rectangles,dropdown,product_list,product_list_with_images,swatch. Required in a /POST.Allowed: date | checkbox | file | text | multi_line_text | numbers_only_text | radio_buttons | rectangles | dropdown | product_list | product_list_with_images | swatch
requiredboolean
requiredWhether or not this modifier is required at checkout. Required in a /POST.
sort_orderinteger
The order the modifiers display on the product detail page.
configobject
The values for option config can vary based on the Modifier created.
option_valuesarray[object]
display_namestring
requiredThe name of the option shown on the storefront.
example
Response
Body
dataobject
example
Get a product modifier
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/modifiers/{modifier_id}Request
Returns a single product modifier. Optional parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
data
Product modifier
example
Update a product modifier
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products/{product_id}/modifiers/{modifier_id}Request
Updates a product modifier.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
The model for a PUT to update a modifier on a product.
example
Response
Body
data
Product modifier