less than a minute read • Updated 40 minutes ago

Discount syntax reference

Reference for Foxy discount methods, types, tiers, and syntax, including how the admin Rules builder maps to the underlying parameters.

Reference for Foxy's discount methods, types, and syntax, and how the admin Rules builder maps to them.

Syntax

discount_method=Discount_Name{discount_type|X-A|Y-B|Z-C}

discount_method: one of the methods below.
Discount_Name: the label shown to the customer. Required.
discount_type: optional. Defaults to single for coupons, or allunits for product and category discounts.
X, Y, Z: tiers (the threshold at which the amount applies).
A, B, C: amounts (a value or a percentage).

Method	Abbreviation	Applies
`discount_quantity_amount`	$/qty	An amount, based on the quantity of discounted products
`discount_quantity_percentage`	%/qty	A percentage, based on quantity (uses the average of applicable products)
`discount_price_amount`	// /	An amount, based on the price of discounted products
`discount_price_percentage`	%/$	A percentage, based on price (uses the average of applicable products)

Type	Also called	Effect	Notes
`allunits`	All-units, volume, bulk	Discounts all affected units	Default for product and category discounts
`incremental`	Incremental	Discounts only the units above each tier	Not useful for // / methods
`repeat`	Buy One, Get One, repeatable	A single tier that repeats	Accepts one tier only. Not useful for // / methods
`single`	Single, one-off, coupon mode	One discount, not spread per product	Default for coupons. For percentage methods, equals `allunits`

Builder control	Maps to
IF quantity ≥ tier	Quantity-based method (`discount_quantity_*`)
IF total ≥ tier	Value-based method (`discount_price_*`)
BY value % percentage	`*_percentage` method
BY value ¤ amount	`*_amount` method
THEN reduce	A discount
THEN increase	A surcharge (adds to the total instead of discounting)
Target: price of each item	`allunits`
Target: price of additional items	`incremental`
Target: price of next item	`repeat`
Target: order total	`single`

Tier format is threshold-amount. For example, 5-10 means "at a threshold of 5, apply 10".
Separate multiple tiers with |. All types accept multiple tiers except repeat, which accepts one.
Tiers only count against the portion of the cart that will receive the discount.

Did this article answer your questions? Need help with anything? Please click below to contact us.