Docs
Catalog API
Product variant options
Values

Values

Get All Product Variant Option Values

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

Request

Returns a list of all Variant Option Values. Optional parameters can be passed in.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Body

object | application/json

Get Option Values response.

  • data    array[object]

  • meta    object

    Data about the response, including pagination and collection totals.

example

Create a Product Variant Option Value

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

Request

Creates a Variant Option Value.

Required Fields

  • label
  • sort_order

Read-Only Fields

  • id

Limits

  • 250 option values per option limit.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

Body

application/json

The model for a POST to create option values on a product.

example

Response

Body

object | application/json

  • data

  • meta    object

    Response metadata.

example

Get a Product Variant Option Value

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

Request

Returns a single Variant Option Value. Optional parameters can be passed in.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Body

object | application/json

  • data

  • meta    object

    Response metadata.

example

Update a Product Variant Option Value

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

Request

Updates a Variant Option Value.

Read-Only Fields

  • id

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

A BigCommerce OptionValue object.

Body

application/json

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

example

Response

Body

object | application/json

  • data

  • meta    object

    Response metadata.

example

Delete a Product Variant Option Value

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

Request

Deletes a Variant Option Value.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Did you find what you were looking for?
Delete a Product Variant OptionGet All Product Variant Option Values