post

/catalog/products/{product_id}/complex-rules

Creates a product Complex Rule.

Required Fields

  • modifier_id
  • modifier_value_id
  • modifier_value_id
  • variant_id

Read-Only Fields

  • complex_rule_id
  • conditions_id
  • rule_id
  • combination_id
  • id

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

1 Path Parameter
2 Headers

Request Body

1 Example
Schema
object

Common ComplexRule properties.

id
integer

The unique numeric ID of the rule; increments sequentially. Read-Only

1 validation
product_id
integer

The unique numeric ID of the product with which the rule is associated; increments sequentially.

3 validations
sort_order
integer

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

3 validations
enabled
boolean

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

1 validation
stop
boolean

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

purchasing_disabled
boolean

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

purchasing_disabled_message
string

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

3 validations
purchasing_hidden
boolean

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

image_url
string

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

1 validation
price_adjuster
object

Adjuster for Complex Rules.

weight_adjuster
object

Adjuster for Complex Rules.

conditions
array[object]

Responses

1 Example
Schema
object
data
object

Common ComplexRule properties.

meta
object

Empty meta object; may be used later.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
product_id
$$.env
2 variables not set
store_hash
X-Auth-Client
X-Auth-Token