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
- •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
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.
- Anchor to effecteffect•Discount
Effect! non-null The discount's effect on qualifying items.
- Anchor to quantityquantity•Discount
Quantity! non-null The number of items being discounted. The customer must have at least this many items of specified products or product variants in their order to be eligible for the discount.
- •OBJECT
A discount effect that gives customers a percentage off of specified items on their order.
- Anchor to percentagepercentage•Float!non-null
The percentage value of the discount.
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.