discount_application
Information about a specific discount.
For how to present discounts in the store theme, refer to Discounts.
Properties
The scope of the line items or shipping lines to which the discount applies.
Whether the scope corresponds to line items or shipping lines depends on the target_type property of the discount.
| Valid value | Description |
|---|---|
| all | All line items or shipping lines. |
| entitled | The line items or shipping lines that meet the specified criteria. |
| explicit | Explicitly selected line items. |
The type of line to which the discount applies.
| Valid value | Description |
|---|---|
| line_item | A line item |
| shipping_line | A shipping line |
The name of the discount for display.
The total discount amount.
Format the amount using the money, money_with_currency, or money_without_currency filter.
The discount value.
The meaning of this value depends on the value_type field of the discount.
Format the amount using the money, money_with_currency or money_without_currency filter.
The type of discount value.
| Value type | Meaning |
|---|---|
| fixed_amount | An amount |
| percentage | A percentage |
The type of activity associated with the discount. Valid values are:
0: Spending and Save, Free Shipping1: Flash Sale2: Bundling3: Coupon4: Landing Page Store5: Gift with Purchase6: Pre-order7: Add-ons8: Gift Sets9: Post-purchase Upsell
The type of discount benefit. Valid values are:
-1: None1: Flat Discount2: % Discount3: Free Shipping4: Upsell5: Any N for Fixed Price6: Set Price7: Gift with Purchase8: Flat Price9: Cheapest One Free11: Nth Item at % Off12: Buy X, Get Y Free13: Manual or Advanced Discount14: Multi-buy Offer