Discount
Requires Apps must have access scope.
The type of discount that will be applied. Currently, only a percentage discount is supported.
Anchor to Possible typesPossible types
- •OBJECT
The fixed amount value of a discount, and whether the amount is applied to each entitled item or spread evenly across the entitled items.
- Anchor to amountamount•Money
V2! non-null The value of the discount.
- Anchor to appliesOnEachItemapplies•Boolean!
On Each Item non-null If true, then the discount is applied to each of the entitled items. If false, then the amount is split across all of the entitled items.
- •OBJECT
Creates percentage-based discounts that reduce item prices by a specified percentage amount. This gives merchants a flexible way to offer proportional savings that automatically scale with order value.
For example, a "20% off all winter clothing" promotion would use this object to apply consistent percentage savings across different price points.
Learn more about discount types.
- Anchor to percentagepercentage•Float!non-null
The percentage value of the discount.
Anchor to Fields with this unionFields with this union
- •OBJECT
Defines quantity-based discount rules that specify how many items are eligible for a discount effect. This object enables bulk purchase incentives and tiered pricing strategies.
For example, a "Buy 4 candles, get 2 candles 50% off (mix and match)" promotion would specify a quantity threshold of 2 items that will receive a percentage discount effect, encouraging customers to purchase more items to unlock savings.
The configuration combines quantity requirements with discount effects, allowing merchants to create sophisticated pricing rules that reward larger purchases and increase average order values.