Catalog - Products
Get Complex Rules
GET /stores/{store_hash}/v3/catalog/products/{product_id}/complex-rules
Request
Returns a list of all product Complex Rules. Optional parameters may be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- include_fields in query - array
Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
- exclude_fields in query - array
Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
- page in query - integer
Specifies the page number in a limited (paginated) list of products.
- limit in query with default of 50 - integer
Controls the number of items per page in a limited (paginated) list of products.
example
Response
Body
Complex Rule Response
dataarray[object]
metaobject
Data about the response, including pagination and collection totals.
example
Create a Complex Rule
POST /stores/{store_hash}/v3/catalog/products/{product_id}/complex-rules
Request
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-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
Common ComplexRule properties.
product_idinteger or null
The unique numeric ID of the product with which the rule is associated; increments sequentially.
Example: 67
sort_orderinteger
The priority to give this rule when making adjustments to the product properties.
Example: 0
enabledboolean
Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty.
Example: true
stopboolean
Flag for determining whether other rules should not be applied after this rule has been applied.
purchasing_disabledboolean
Flag for determining whether the rule should disable purchasing of a product when the conditions are applied.
purchasing_disabled_messagestring
>= 0 characters<= 255 charactersMessage displayed on the storefront when a rule disables the purchasing of a product.
Example: This product is not available at this time.
purchasing_hiddenboolean
Flag for determining whether the rule should hide purchasing of a product when the conditions are applied.
image_urlstring
The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file.
Example: https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png
price_adjusterobject
Adjuster for Complex Rules.
weight_adjusterobject
Adjuster for Complex Rules.
conditionsarray[object]
example
Response
Body
dataobject
Common ComplexRule properties.
metaobject
Response metadata.
example
Get a Product Complex Rule
GET /stores/{store_hash}/v3/catalog/products/{product_id}/complex-rules/{complex_rule_id}
Request
Returns a single Complex Rule. Optional parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- include_fields in query - array
Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
- exclude_fields in query - array
Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
example
Response
Body
dataobject
Common ComplexRule properties.
metaobject
Response metadata.
example
Update a Product Complex Rule
PUT /stores/{store_hash}/v3/catalog/products/{product_id}/complex-rules/{complex_rule_id}
Request
Updates a Complex Rule.
Required Fields:
- none
Read-Only Fields:
- complex_rule_id
- conditions_id
- rule_id
- combination_id
- id
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
Common ComplexRule properties.
product_idinteger or null
The unique numeric ID of the product with which the rule is associated; increments sequentially.
Example: 67
sort_orderinteger
The priority to give this rule when making adjustments to the product properties.
Example: 0
enabledboolean
Flag for determining whether the rule is to be used when adjusting a productʼs price, weight, image, or availabilty.
Example: true
stopboolean
Flag for determining whether other rules should not be applied after this rule has been applied.
purchasing_disabledboolean
Flag for determining whether the rule should disable purchasing of a product when the conditions are applied.
purchasing_disabled_messagestring
>= 0 characters<= 255 charactersMessage displayed on the storefront when a rule disables the purchasing of a product.
Example: This product is not available at this time.
purchasing_hiddenboolean
Flag for determining whether the rule should hide purchasing of a product when the conditions are applied.
image_urlstring
The URL for an image displayed on the storefront when the conditions are applied. Limit of 8MB per file.
Example: https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png
price_adjusterobject
Adjuster for Complex Rules.
weight_adjusterobject
Adjuster for Complex Rules.
conditionsarray[object]
example
Response
Body
dataobject
Common ComplexRule properties.
metaobject
Response metadata.
example
Delete a Product Complex Rule
DELETE /stores/{store_hash}/v3/catalog/products/{product_id}/complex-rules/{complex_rule_id}
Request
Deletes a product Complex Rule.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- product_id in path - integerrequired
The ID of the
Product
to which the resource belongs. - complex_rule_id in path - integerrequired
The ID of the
ComplexRule
.