Discount
Requires Apps must have access scope.
The type of the discount value and how it will be applied. For example, it might be a percentage discount on a fixed number of items. Alternatively, it might be a fixed amount evenly distributed across all items or on each individual item. A third example is a percentage discount on all items.
Anchor to Possible typesPossible types
- DiscountAmount (DiscountAmount)
- DiscountOnQuantity (DiscountOnQuantity)
- DiscountPercentage (DiscountPercentage)
- •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.
- •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.
- •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 Fields with this unionFields with this union
- •OBJECT
The items in the order that qualify for the discount, their quantities, and the total value of the discount.