ReDoc documentation

catalogPriceRules

catalogPriceRules

Create a new catalog price rule. Rules are created inactive unless is_active is explicitly set, so a bulk import cannot reprice the catalog before the payload has been reviewed.

Request
Request Body schema:
required
object (catalog-price-rule-api-data-catalog-price-rule-interface)

Data interface for a catalog price rule exposed over REST. This is a constrained view of the underlying rule: it adds the scoping and date fields the vendor @api RuleInterface omits, and exposes the condition tree as typed, server-validated leaves and nested groups instead of raw arrays.

Responses
200

200 Success.

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

post/V1/catalogPriceRules
Request samples
{
  • "rule": {
    }
}
Response samples
{
  • "condition": {
    },
  • "customer_group_ids": [
    ],
  • "description": "string",
  • "discount_amount": 0,
  • "from_date": "string",
  • "is_active": 0,
  • "name": "string",
  • "rule_id": 0,
  • "simple_action": "string",
  • "sort_order": 0,
  • "stop_rules_processing": 0,
  • "to_date": "string",
  • "website_ids": [
    ]
}
➔ Next to catalogPriceRules/metadata