v1

latestSwagger 2.02026-07-17148179252.3 KB
Catalog

Creates a Modifier.

post/catalog/products/{product_id}/modifiers

Request body

type'date' | 'checkbox' | 'file' | 'text' | 'multi_line_text' | 'numbers_only_text' | 'radio_buttons' | 'rectangles' | 'dropdown' | 'product_list' | 'product_list_with_images' | 'swatch'

BigCommerce 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. For reference, the former v2 API values are: D = date, C = checkbox, F = file, T = text, MT = multi_line_text, N = numbers_only_text, RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.

requiredboolean

Whether or not this modifer is required or not at checkout.

sort_orderinteger

The order the modifiers display on the product detail page.

display_namestring

The name of the option shown on the storefront.

Response

A Modifier object.

metaMeta

Empty meta object; may be used later.