List Product Modifier Values

GET

https://api.bigcommerce.com/stores/:store_hash/v3/catalog/products/:product_id/modifiers/:modifier_id/values

GET

/stores/:store_hash/v3/catalog/products/:product_id/modifiers/:modifier_id/values

curl https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/modifiers/1/values \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

200Response

{
  "data": [
    {
      "adjusters": {
        "price": {
          "adjuster": "relative",
          "adjuster_value": 5
        },
        "weight": {},
        "image_url": "",
        "purchasing_disabled": {
          "status": false,
          "message": ""
        }
      },
      "id": 190,
      "is_default": false,
      "label": "Yes",
      "option_id": 222,
      "sort_order": 0,
      "value_data": {
        "checked_value": true
      }
    },
    {
      "adjusters": {
        "price": {},
        "weight": {},
        "image_url": "",
        "purchasing_disabled": {
          "status": false,
          "message": ""
        }
      },
      "id": 191,
      "is_default": true,
      "label": "No",
      "option_id": 222,
      "sort_order": 1,
      "value_data": {
        "checked_value": false
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "count": 2,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "current": "?page=1&limit=50"
      }
    }
  }
}

Returns a list of all product Modifier Values. Optional parameters can be passed in.

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.

modifier_idintegerRequired

The ID of the product modifier.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

include_fieldslist of stringsOptional

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

exclude_fieldslist of stringsOptional

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

pageintegerOptional

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

limitintegerOptional<=250Defaults to 50

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

Response

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination and collection totals.