BigCommerce
Catalog API
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
  • 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 Modifier.

  • modifier_id in path - integer - required

    The ID of the Modifier.

  • include_fields in query - string

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

  • exclude_fields in query - string

    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 - 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.

  • modifier_id in path - integer - required

    The ID of the Modifier.

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
      • 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 Modifier.

      • value_id in path - integer - required

        The ID of the Modifier/Option Value.

      • modifier_id in path - integer - required

        The ID of the Modifier.

      • value_id in path - integer - required

        The ID of the Modifier/Option Value.

      • include_fields in query - string

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

      • exclude_fields in query - string

        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 Modifer 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.

      • modifier_id in path - integer - required

        The ID of the Modifier.

      • value_id in path - integer - required

        The ID of the Modifier/Option Value.

      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 Modifier.

          • value_id in path - integer - required

            The ID of the Modifier/Option Value.

          • modifier_id in path - integer - required

            The ID of the Modifier.

          • value_id in path - integer - required

            The ID of the Modifier/Option Value.

          example

          Response

          Did you find what you were looking for?