post

/catalog/products/{product_id}/modifiers

Creates a Product Modifier.

Required Fields

  • required
  • display_name
  • type

Read-Only Fields

  • id

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

1 Path Parameter
2 Headers

Request Body

3 Examples
Schema
object

The model for a POST to create a modifier on a product.

type
string

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. Required in a /POST.

2 validations + required
required
boolean

Whether or not this modifer is required or not at checkout. Required in a /POST.

1 validation + required
sort_order
integer

The order the modifiers display on the product detail page.

config
object

The values for option config can vary based on the Modifier created.

option_values
array[object]
display_name
string

The name of the option shown on the storefront.

2 validations + required

Responses

1 Example
Schema
object
data
object

Product Modifier

meta
object

Empty meta object; may be used later.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
product_id
$$.env
2 variables not set
store_hash
X-Auth-Client
X-Auth-Token