Create Product Modifier

using RestSharp;
var client = new RestClient("https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/product_id/modifiers");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Auth-Token", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"type\": \"radio_buttons\",\n  \"required\": true,\n  \"display_name\": \"Donation\",\n  \"sort_order\": 0,\n  \"option_values\": [\n    {\n      \"is_default\": false,\n      \"adjusters\": {\n        \"price\": {\n          \"adjuster\": \"relative\",\n          \"adjuster_value\": 5\n        },\n        \"weight\": {\n          \"adjuster\": \"relative\",\n          \"adjuster_value\": 5\n        },\n        \"purchasing_disabled\": {\n          \"status\": true,\n          \"message\": \"string\"\n        }\n      },\n      \"label\": \"+5\",\n      \"sort_order\": 0,\n      \"value_data\": {}\n    },\n    {\n      \"is_default\": false,\n      \"adjusters\": {\n        \"price\": {\n          \"adjuster\": \"relative\",\n          \"adjuster_value\": 10\n        },\n        \"weight\": {\n          \"adjuster\": \"relative\",\n          \"adjuster_value\": 10\n        },\n        \"purchasing_disabled\": {\n          \"status\": true,\n          \"message\": \"string\"\n        }\n      },\n      \"label\": \"+10\",\n      \"sort_order\": 0,\n      \"value_data\": {}\n    }\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

{
  "data": {
    "id": 164,
    "product_id": 161,
    "name": "Test-name1716906851-161",
    "display_name": "Test name",
    "type": "radio_buttons",
    "required": true,
    "sort_order": 0,
    "config": {},
    "option_values": [
      {
        "id": 199,
        "option_id": 164,
        "label": "+5",
        "sort_order": 0,
        "is_default": false,
        "adjusters": {
          "price": {
            "adjuster": "relative",
            "adjuster_value": 5
          },
          "weight": {
            "adjuster": "relative",
            "adjuster_value": 5
          },
          "image_url": "",
          "purchasing_disabled": {
            "status": true,
            "message": "string"
          }
        }
      },
      {
        "id": 200,
        "option_id": 164,
        "label": "+10",
        "sort_order": 0,
        "is_default": false,
        "adjusters": {
          "price": {
            "adjuster": "relative",
            "adjuster_value": 10
          },
          "weight": {
            "adjuster": "relative",
            "adjuster_value": 10
          },
          "image_url": "",
          "purchasing_disabled": {
            "status": true,
            "message": "string"
          }
        }
      }
    ]
  },
  "meta": {}
}

Creates a product modifier.

Required Fields

required
display_name
type

Read-Only Fields

id

Notes It takes two separate requests to create a new checkbox modifier with option values. Perform a request to create a modifier, then perform a second request to update option values.

Date modifiers are required to be provided in ISO-8601 ATOM format. Excluding them in a request will throw a server error.

Creates a product modifier. **Required Fields** * `required` * `display_name` * `type` **Read-Only Fields** * `id` **Notes** It takes two separate requests to create a new checkbox modifier with option values. Perform a request to create a modifier, then perform a second request to update option values. Date modifiers are required to be provided in [ISO-8601 ATOM](https://www.php.net/manual/en/class.datetimeinterface.php#datetimeinterface.constants.atom) format. Excluding them in a request will throw a server error.

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_idstringRequired

Request

This endpoint expects an object.

typeenumRequired

BigCommerce API, which determines how it will display on the storefront. Acceptable values: date, checkbox, file, text, multi_line_text, numbers_only_text, radio_buttons, rectangles, dropdown, product_list, product_list_with_images, swatch. Required in a /POST.

BigCommerce API, which determines how it will display on the storefront. Acceptable values: `date`, `checkbox`, `file`, `text`, `multi_line_text`, `numbers_only_text`, `radio_buttons`, `rectangles`, `dropdown`, `product_list`, `product_list_with_images`, `swatch`. Required in a /POST.

requiredbooleanRequired

Whether or not this modifier is required at checkout. Required in a /POST.

display_namestringRequired

The name of the option shown on the storefront.

sort_orderintegerOptional

The order the modifiers display on the product detail page.

configobjectOptional

The values for option config can vary based on the Modifier created. See Configs to learn more about the type-specific config fields.

option_valueslist of objectsOptional

Contains information about the values for modifier types with options. Certain fields are not used for specific modifier types. See Option Values for more details.

Response

dataobject

metaobject

Response metadata.

Errors

409

Conflict Error

422

Unprocessable Entity Error

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Request

Response

Errors

OAuth scopes

Authentication header

Further reading