put

/catalog/products/{product_id}/options/{option_id}/values/{value_id}

Updates a Variant Option Value.

Read-Only Fields

  • id

Authorization

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

Request Parameters

3 Path Parameters
2 Headers

Request Body

A BigCommerce OptionValue object.

Schema
object

The model for a PUT to update option values on a product.

is_default
boolean

The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers.

1 validation
label
string

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

2 validations + required
sort_order
integer

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

4 validations + required
value_data
object

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

id
integer

The unique numeric ID of the value; increments sequentially.

1 validation

Responses

1 Example
Schema
object
data
object

Common Option Value properties.

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
3 path params not set
product_id
option_id
value_id
$$.env
2 variables not set
store_hash
X-Auth-Client
X-Auth-Token