Create Product Variant Option | BigCommerce Developer Center

Creates a Variant Option.

Required Fields

display_name
type
option_values

Read-Only Fields

Limits

255 characters option name length.

Notes

Only one variant option at a time can be created; individual variant options will contain an array of multiple values.
There are several examples listed below that create options, but the SKUs are not updated and they are not a variant on the product. Variant SKUs must be created with a separate request.
Variant options will show on the storefront as an option that can be selected by the customer. A request like this could be used to add new choices to a variant that has already been created.
If more than one variant needs to be created, use the Create a Product endpoint.

Creates a *Variant Option*. **Required Fields** * display_name * type * option_values **Read-Only Fields** * id **Limits** * 255 characters option name length. **Notes** * Only one variant option at a time can be created; individual variant options will contain an array of multiple values. * There are several examples listed below that create options, but the SKUs are not updated and they are not a variant on the product. Variant SKUs must be created with a separate request. * Variant options will show on the storefront as an option that can be selected by the customer. A request like this could be used to add new choices to a variant that has already been created. * If more than one variant needs to be created, use the [Create a Product](/developer/api-reference/rest/admin/catalog/products#create-a-product) endpoint.

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.

### 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](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

product_idstringRequired

Request

Common Option properties.

product_idintegerOptional

The unique numerical ID of the product to which the option belongs.

display_namestringOptional1-255 characters

The name of the option shown on the storefront.

typeenumOptional

The type of option, which determines how it will display on the storefront. Acceptable values: radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.

The type of option, which determines how it will display on the storefront. Acceptable values: `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. For reference, the former v2 API values are: RB = radio_buttons, RT = rectangles, S = dropdown, P = product_list, PI = product_list_with_images, CS = swatch.

configobjectOptional

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

sort_orderintegerOptional

Order in which the option is displayed on the storefront.

option_valueslist of objectsOptional

image_urlstringOptional

Publicly available image url

Response

dataobject

Common Option properties.

metaobject

Empty meta object; may be used later.

Errors

409

Conflict Error

422

Unprocessable Entity Error

1	curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/product_id/options \
2	-H "X-Auth-Token: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"data": {
3	"id": 55,
4	"product_id": 4,
5	"display_name": "Add-a-$5-Donation1535042499-187",
6	"type": "radio_buttons",
7	"config": {
8	"default_value": "string",
9	"checked_by_default": true,
10	"checkbox_label": "string",
11	"date_limited": true,
12	"date_limit_mode": "earliest",
13	"date_earliest_value": "2022-08-24T00:00:00+00:00",
14	"date_latest_value": "2022-08-27T00:00:00+00:00",
15	"file_types_mode": "specific",
16	"file_types_supported": [
17	"images, documents, other"
18	],
19	"file_types_other": [
20	"pdf"
21	],
22	"file_max_size": 5,
23	"text_characters_limited": true,
24	"text_min_length": 1,
25	"text_max_length": 55,
26	"text_lines_limited": true,
27	"text_max_lines": 4,
28	"number_limited": true,
29	"number_limit_mode": "lowest",
30	"number_lowest_value": 100,
31	"number_highest_value": 0,
32	"number_integers_only": false,
33	"product_list_adjusts_inventory": true,
34	"product_list_adjusts_pricing": true,
35	"product_list_shipping_calc": "none"
36	},
37	"sort_order": 1,
38	"option_values": [
39	{
40	"label": "Green",
41	"sort_order": 0,
42	"is_default": false,
43	"value_data": {},
44	"id": 0
45	}
46	],
47	"image_url": "string",
48	"name": "Add-a-$5-Donation1535042499-187"
49	},
50	"meta": {}
51	}