Create Complex Rule

POST

https://api.bigcommerce.com/stores/:store_hash/v3/catalog/products/:product_id/complex-rules

POST

/stores/:store_hash/v3/catalog/products/:product_id/complex-rules

curl -X POST https://api.bigcommerce.com/stores/store_hash/v3/catalog/products/1/complex-rules \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "conditions": [
    {}
  ]
}'

{
  "data": {
    "id": 5,
    "product_id": 67,
    "sort_order": 0,
    "enabled": true,
    "stop": true,
    "purchasing_disabled": true,
    "purchasing_disabled_message": "This product is not available at this time.",
    "purchasing_hidden": true,
    "image_url": "https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png",
    "price_adjuster": {
      "adjuster": "relative",
      "adjuster_value": 5
    },
    "weight_adjuster": {
      "adjuster": "relative",
      "adjuster_value": 5
    },
    "conditions": [
      {
        "modifier_id": 55,
        "modifier_value_id": 256,
        "variant_id": 1,
        "id": 3,
        "rule_id": 4,
        "combination_id": 1
      }
    ]
  },
  "meta": {}
}

Creates a product Complex Rule.

Required Fields

conditions
modifier_id
modifier_value_id
variant_id

Read-Only Fields

complex_rule_id
conditions_id
rule_id
combination_id
id

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.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

Common ComplexRule properties.

conditionslist of objectsRequired

sort_orderintegerOptional-2147483648-2147483647

The priority to give this rule when making adjustments to the product properties.

enabledbooleanOptional

Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty.

stopbooleanOptional

Flag for determining whether other rules should not be applied after this rule has been applied.

purchasing_disabledbooleanOptional

Flag for determining whether the rule should disable purchasing of a product when the conditions are applied.

purchasing_disabled_messagestringOptional0-255 characters

Message displayed on the storefront when a rule disables the purchasing of a product.

purchasing_hiddenbooleanOptional

Flag for determining whether the rule should hide purchasing of a product when the conditions are applied.

image_urlstringOptional

The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file.

price_adjusterobjectOptional

Adjuster for Complex Rules.

weight_adjusterobjectOptional

Adjuster for Complex Rules.

Response

dataobjectOptional

Common ComplexRule properties.

metaobjectOptional

Response metadata.

Errors

409

Conflict Error

422

Unprocessable Entity Error