Closed Beta ProgramsShared Options and ModifiersAPI ReferenceOption Values

Create Shared Option Values (batch)

Beta
Bulk create option values for an existing shared option.

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](/developer/docs/overview/api-fundamentals/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-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/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

option_idstringRequired

Request

This endpoint expects a list of objects.
labelstringRequired1-255 characters
The unique text display within one option identifying the value on the storefront. Unique within an option.
sort_orderintegerRequired-2147483648-2147483647
The order in which the value displays on the storefront or in response bodies.
value_dataobjectOptional
Additional data describing values for swatch option types.
is_defaultbooleanOptional
The flag for preselecting a value as the default on the storefront. Up to one default per option. This field is not supported for swatch options.

Response

An array of SharedProductOptionValue objects.

datalist of objects
metaobject
Data about the response, including pagination and collection totals.

Errors

422
Unprocessable Entity Error