Create Product Modifier Value

POST

https://api.bigcommerce.com/stores/:store_hash/v3/catalog/products/:product_id/modifiers/:modifier_id/values

POST

/stores/:store_hash/v3/catalog/products/:product_id/modifiers/:modifier_id/values

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/modifiers/1/values \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "label": "Yes",
  "sort_order": 0,
  "is_default": false,
  "value_data": {},
  "adjusters": {
    "price": {
      "adjuster": "relative",
      "adjuster_value": 5
    }
  }
}'

{
  "data": {
    "adjusters": {
      "price": {
        "adjuster": "relative",
        "adjuster_value": 5
      },
      "weight": {},
      "image_url": "",
      "purchasing_disabled": {
        "status": false,
        "message": ""
      }
    },
    "id": 190,
    "is_default": false,
    "label": "Yes",
    "option_id": 222,
    "sort_order": 0,
    "value_data": {}
  },
  "meta": {}
}

Creates a modifier value.

Read-Only Fields

is_default

Setting an option value image adjusters.image_url is read-only on this endpoint. To attach the image shown on the storefront for the value, upload it via Create Product Modifier Image after creating the value.

is_default is derived from the parent modifier configuration and cannot be set on individual values. To change which value is the default, use Update Product Modifier and include the full option_values array with the desired is_default flags.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Products	modify	`store_v2_products`
Products	read-only	`store_v2_products_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

product_idintegerRequired

The ID of the product to which the resource belongs.

modifier_idintegerRequired

The ID of the product modifier.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

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

labelstringRequired

The text display identifying the value on the storefront. Required in a /POST.

sort_orderintegerRequired

The order in which the value will be displayed on the product page. Required in a /POST.

value_dataobjectOptional

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 hexadecimal 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.

adjustersobjectOptional

Response

dataobjectOptional

Product modifier option_value.

metaobjectOptional

Response metadata.

Errors

422

Unprocessable Entity Error