Update Product Variant Option

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/catalog/products/:product_id/options/:option_id

PUT

/stores/:store_hash/v3/catalog/products/:product_id/options/:option_id

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

{
  "data": {
    "id": 220,
    "product_id": 192,
    "display_name": "Color",
    "type": "swatch",
    "config": {},
    "sort_order": 0,
    "option_values": [
      {
        "label": "Beige",
        "sort_order": 1,
        "is_default": false,
        "value_data": {
          "colors": [
            "#FAFAEB"
          ]
        },
        "id": 174
      },
      {
        "label": "Grey",
        "sort_order": 2,
        "is_default": false,
        "value_data": {
          "colors": [
            "#BDBDBD"
          ]
        },
        "id": 175
      },
      {
        "label": "Black",
        "sort_order": 3,
        "is_default": false,
        "value_data": {
          "colors": [
            "#000000"
          ]
        },
        "id": 176
      },
      {
        "label": "Black-Walnut",
        "sort_order": 4,
        "is_default": false,
        "value_data": {
          "colors": [
            "#e80ee8"
          ]
        },
        "id": 189
      }
    ],
    "name": "Color (Colors only)"
  },
  "meta": {}
}

Updates a Variant Option.

Read-Only Fields

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.

option_idintegerRequired

The ID of the Option.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

The model for a PUT to update options on a product.

idinteger or nullOptional

The unique numerical ID of the option, increments sequentially.

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.

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

dataobjectOptional

Common Option properties.

metaobjectOptional

Response metadata.

Errors

409

Conflict Error

422

Unprocessable Entity Error