Discount
Requires Apps must have access scope.
The prerequisite for the discount to be applicable. For example, the discount might require a customer to buy a minimum quantity of select items. Alternatively, the discount might require a customer to spend a minimum amount on select items.
Anchor to Possible typesPossible types
- •OBJECT
A purchase amount in the context of a discount. This object can be used to define the minimum purchase amount required for a discount to be applicable.
- Anchor to amountamount•Decimal!non-null
The purchase amount in decimal format.
- •OBJECT
Defines a quantity threshold for discount eligibility or application. This simple object specifies the number of items required to trigger or calculate discount benefits.
For example, a "Buy 3, Get 1 Free" promotion would use DiscountQuantity to define the minimum purchase quantity of 3 items, or a bulk discount might specify quantity tiers like 10+ items for wholesale pricing.
The quantity value determines how discounts interact with cart contents, whether setting minimum purchase requirements or defining quantity-based discount calculations.
- Anchor to quantityquantity•Unsigned
Int64! non-null The quantity of items.
Anchor to Fields with this unionFields with this union
- •OBJECT
The prerequisite items and prerequisite value that a customer must have on the order for the discount to be applicable.