PUT /catalog/products/{product_id}/options/{option_id}/values/{value_id}
Updates a Variant Option Value.
Read-Only Fields
- id
Servers
- https://api.bigcommerce.com/stores/{store_hash}/v3
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
option_id |
Integer | Yes |
The ID of the |
product_id |
Integer | Yes |
The ID of the |
value_id |
Integer | Yes |
The ID of the |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Accept |
String | Yes |
The MIME type of the response body. Default value: "application/json" |
Content-Type |
String | Yes |
The MIME type of the request body. Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
Integer | No |
The unique numeric ID of the value; increments sequentially. |
is_default |
Boolean | No |
The flag for preselecting a value as the default on the storefront. This field is not supported for swatch options/modifiers. |
sort_order |
Integer | Yes |
The order in which the value will be displayed on the product page. Required in a /POST. |
label |
String | Yes |
The text display identifying the value on the storefront. Required in a /POST. |
value_data |
Object | No |
Extra data describing the value, based on the type of option or modifier with which the value is associated. The |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.