Get Product Modifier

GET

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

GET

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

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

{
  "data": {
    "required": true,
    "type": "date",
    "config": {
      "default_value": "string",
      "checked_by_default": true,
      "checkbox_label": "string",
      "date_limited": true,
      "date_limit_mode": "range",
      "date_earliest_value": "2025-08-15T15:52:01+00:00",
      "date_latest_value": "2026-08-15T15:52:01+00:00",
      "file_types_mode": "specific",
      "file_types_supported": [
        "images, documents, other"
      ],
      "file_types_other": [
        "pdf"
      ],
      "file_max_size": 5,
      "text_characters_limited": true,
      "text_min_length": 1,
      "text_max_length": 55,
      "text_lines_limited": true,
      "text_max_lines": 4,
      "number_limited": true,
      "number_limit_mode": "lowest",
      "number_lowest_value": 100,
      "number_highest_value": 1.1,
      "number_integers_only": false,
      "product_list_adjusts_inventory": true,
      "product_list_adjusts_pricing": true,
      "product_list_shipping_calc": "weight"
    },
    "display_name": "string",
    "id": 12,
    "name": "Add-a-$5-Donation1535039590-191",
    "option_values": [
      {
        "adjusters": {
          "price": {
            "adjuster": "relative",
            "adjuster_value": 5
          },
          "weight": {
            "adjuster": "relative",
            "adjuster_value": 5
          },
          "image_url": "https://cdn8.bigcommerce.com/s-{{store_hash}}/products/184/images/445/naturalcanvascart2_1024x1024__92347__29648.1534344533.1280.1280.jpg?c=2",
          "purchasing_disabled": {
            "status": true,
            "message": "string"
          }
        },
        "id": 1,
        "is_default": false,
        "label": "Green",
        "option_id": 1,
        "sort_order": 0,
        "value_data": {}
      }
    ],
    "product_id": 77,
    "sort_order": 1
  },
  "meta": {}
}

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

Response

dataobjectOptional

Product modifier

metaobjectOptional

Response metadata.

Errors

404

Not Found Error