Defines how discounts are automatically applied to a set of items that match the pricing rule during the active time period.
<- Object
Object
Defines how discounts are automatically applied to a set of items that match the pricing rule during the active time period.
User-defined name for the pricing rule. For example, "Buy one get one free" or "10% off".
A list of unique IDs for the catalog time periods when this pricing rule is in effect. If left unset, the pricing rule is always in effect.
Unique ID for the CatalogDiscount
to take off the price of all matched items.
Unique ID for the CatalogProductSet
that will be matched by this rule. A match rule matches within the entire cart. A match rule can match multiple times in the cart. If no ProductSet
is present, the rule will match all products.
Deprecated: Please use the exclude_products_id
field to apply an exclude set instead. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount.
CatalogProductSet
to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.
CatalogProductSet
to exclude from the pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules.
Represents the date the Pricing Rule is valid from. Represented in RFC3339 full-date format (YYYY-MM-DD).
Represents the local time the pricing rule should be valid from. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.
Represents the date the Pricing Rule is valid until. Represented in RFC3339 full-date format (YYYY-MM-DD).
Represents the local time the pricing rule should be valid until. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated.