For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
        • Brands
        • Categories
        • Category Trees
        • Products
            • GETList Products
            • PUTUpdate Products (batch)
            • POSTCreate Product
            • DELDelete Products
            • GETGet Product
            • PUTUpdate Product
            • DELDelete Product
              • GETList Complex Rules
              • POSTCreate Complex Rule
              • GETGet Product Complex Rule
              • PUTUpdate Product Complex Rule
              • DELDelete Product Complex Rule
        • Product Modifiers
        • Product Variants
        • Product Variant Options
      • Payments
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTAdminCatalogProductsComplex Rules

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 '{}'
1{
2  "data": {
3    "id": 5,
4    "product_id": 67,
5    "sort_order": 1,
6    "enabled": true,
7    "stop": false,
8    "purchasing_disabled": false,
9    "purchasing_disabled_message": "This product is not available at this time.",
10    "purchasing_hidden": false,
11    "image_url": "https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png",
12    "price_adjuster": {
13      "adjuster": "relative",
14      "adjuster_value": 10
15    },
16    "weight_adjuster": {
17      "adjuster": "percentage",
18      "adjuster_value": 15
19    },
20    "conditions": [
21      {
22        "modifier_id": 55,
23        "modifier_value_id": 256,
24        "variant_id": 1,
25        "id": 3,
26        "rule_id": 4,
27        "combination_id": 1
28      }
29    ]
30  },
31  "meta": {}
32}
Creates a product *Complex Rule*. **Required Fields** - modifier_id - modifier_value_id - variant_id **Read-Only Fields** - complex_rule_id - conditions_id - rule_id - combination_id - id
Was this page helpful?
Previous

List Complex Rules

Next

Get Product Complex Rule

Built with

Creates a product Complex Rule.

Required Fields

  • 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](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

product_idintegerRequired

The ID of the Product to which the resource belongs.

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json
The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.

Request

Common ComplexRule properties.
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.
conditionslist of objectsOptional

Response

dataobject
Common ComplexRule properties.
metaobject
Response metadata.

Errors

409
Conflict Error
422
Unprocessable Entity Error

OAuth scopes

UI NamePermissionParameter
Productsmodifystore_v2_products
Productsread-onlystore_v2_products_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

The MIME type of the response body.