Docs
Catalog API
Product modifiers
Values

Values

Get all product modifier values

GET /catalog/products/{product_id}/modifiers/{modifier_id}/values

Request

Returns a list of all product Modifier 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

Returns for GET All Modifier Values on a Product

  • data    array[]

  • meta    object

    Data about the response, including pagination and collection totals.

example

Create product modifier value

POST /catalog/products/{product_id}/modifiers/{modifier_id}/values

Request

Creates a modifier value.

Required Fields

  • label
  • sort_order

Read-Only Fields

  • id

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

Body

application/json

The model for a POST to create a modifier value on a product.

example

Response

Body

object | application/json

  • data

    Part of Modifier Value Response

  • meta    object

    Response metadata.

example

Get a product modifier value

GET /catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}

Request

Returns a single modifier 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

    Product modifier option_value.

  • meta    object

    Response metadata.

example

Update a product modifier value

PUT /catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}

Request

Updates a modifier value.

Required Fields

  • none

Read-Only Fields

  • id

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

Body

application/json

The model for a PUT to update a modifier value on a product.

example

Response

Body

object | application/json

  • data

    Part of Modifier Value Response

  • meta    object

    Response metadata.

example

Delete product modifier value

DELETE /catalog/products/{product_id}/modifiers/{modifier_id}/values/{value_id}

Request

Deletes a modifier value.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Did you find what you were looking for?
Create product modifier ImageGet all product modifier values