BigCommerce
Catalog API
Product Modifiers
Values

Catalog - Product modifiers

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
  • include_fields in query - array

    Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

  • exclude_fields in query - array

    Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

  • page in query - integer

    Specifies the page number in a limited (paginated) list of products.

  • limit in query with default of 50 - integer

    Controls the number of items per page in a limited (paginated) list of products.

example

Response

Body

object | application/json

Returns for GET All Modifier Values on a Product

  • data    array[object]

  • 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
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

application/json

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

      example

      Response

      Body

      object | application/json

      • data        object

        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
      • include_fields in query - array

        Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

      • exclude_fields in query - array

        Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

      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
      • Content-Type in header with default of application/json - string
        required

        The MIME type of the request body.

      Body

      application/json

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

        • id          integer

          The unique numeric ID of the value; increments sequentially.

          example

          Response

          Body

          object | application/json

          • data            object

            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
          • Accept in header with default of application/json - string
            required

            The MIME type of the response body.

          • product_id in path - integer
            required

            The ID of the product to which the resource belongs.

          • modifier_id in path - integer
            required

            The ID of the product modifier.

          • value_id in path - integer
            required

            The ID of the product modifier value.

          example

          Response

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