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

Updates a Complex Rule.

Required Fields:

Read-Only Fields:

Servers

Path parameters

Name Type Required Description
complex_rule_id Integer Yes

The ID of the ComplexRule.

product_id Integer Yes

The ID of the Product to which the resource belongs.

Request headers

Name Type Required Description
Accept String Yes

The MIME type of the response body.

Default value: "application/json"

Content-Type String Yes

The MIME type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
price_adjuster Object No

Adjuster for Complex Rules.

price_adjuster.adjuster_value Number No

The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.

price_adjuster.adjuster String No

The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.

Valid values:

  • "relative"
  • "percentage"
stop Boolean No

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

sort_order Integer No

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

purchasing_disabled Boolean No

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

purchasing_disabled_message String No

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

enabled Boolean No

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

conditions[] Array No
conditions[].modifier_id Integer Yes

The unique numeric ID of the modifier with which the rule condition is associated. Required in /POST.

conditions[].variant_id Integer Yes

The unique numeric ID of the variant with which the rule condition is associated. Required in /POST.

conditions[].modifier_value_id Integer Yes

The unique numeric ID of the modifier value with which the rule condition is associated. Required in /POST.

purchasing_hidden Boolean No

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

weight_adjuster Object No

Adjuster for Complex Rules.

weight_adjuster.adjuster_value Number No

The numeric amount by which the adjuster will change either the price or the weight of the variant, when the modifier value is selected on the storefront.

weight_adjuster.adjuster String No

The type of adjuster for either the price or the weight of the variant, when the modifier value is selected on the storefront.

Valid values:

  • "relative"
  • "percentage"
image_url String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.