Read our dedicated guide to learn about some use cases these endpoints can cover here.
Qualifications Check Eligibility Response Body
Redeemables
Order Calculated No Customer Data
Stacking Rules
Combined response of redeemable object and multiple redeemables within
All of:Customer Id
Referrer Id
Customer IdOrder Redemptions
Single redeemable
Redeemable Result
Applicable To Result List
Inapplicable To Result List
Category with Stacking Rules Type
Category object withstacking_rules_type
All of:
Validation Rules Assignments List
Discount
Contains information about discount. One of: Amount, Unit, Unit Multiple, Percent, FixedBundle Details
Redeemable Gift
Redeemable Loyalty Card
Error Object
Applicable To
-
APPLY_TO_ITEMS_BY_QUANTITY(each unit of matched products has the same discount value) | | order_item_indicesarray| Lists which order lines are (not) covered by the discount. The order in the array is determined by the sequence of applied discounts, while the numbers correspond to the order lines sent in theorderobject in the request. The first order line is assigned0, the second order line is assigned1, and so on. | | order_item_unitsarray| Lists which units within order lines are covered by the discount. The order line items are listed according to sequence of applied discounts while theindexcorresponds to the order line sent in theorderobject in the request.Array of:Attributes Descriptionindexinteger Number assigned to the order line item in accordance with the order sent in the request. unitsarray Numbers of units in the order line covered by the discount; e.g. 2, 5, 8 for 10 units with the setting “skip_initially”: 1, “repeat”: 3. The counting of units starts from 1. The maximum quantity of all handled units is 1000. If the quantity of all order items exceeds 1000, this array is not returned, but units_limit_exceeded: true. However, the discount is calculated properly for all relevant units. units_limit_exceededboolean Returned as true only when the sum total of quantity of all order items exceeds 1000. | | repeatinteger| Determines the recurrence of the discount, e.g."repeat": 3means that the discount is applied to every third item. | | skip_initiallyinteger| Determines how many items are skipped before the discount is applied. | | targetstring| Determines to which kinds of objects the discount is applicable.ITEMincludes products and SKUs.UNITmeans particular units within an order line.Available values:ITEM,UNIT|
Inapplicable To
Applicable ToCategory
Business Validation Rule Assignment
Amount
Unit
Unit Multiple
Percent
Fixed
Loyalties Transfer Points
Applicable To Effect
Available values:APPLY_TO_EVERY, APPLY_TO_CHEAPEST, APPLY_FROM_CHEAPEST, APPLY_TO_MOST_EXPENSIVE, APPLY_FROM_MOST_EXPENSIVE
Discount Amount Vouchers Effect Types
Available values:APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY
Discount Unit Vouchers Effect Types
Available values:ADD_MISSING_ITEMS, ADD_NEW_ITEMS, ADD_MANY_ITEMS
Simple Product Discount Unit
Simple Sku Discount Unit
One Unit
Discount Percent Vouchers Effect Types
Available values:APPLY_TO_ORDER, APPLY_TO_ITEMS
Discount Fixed Vouchers Effect Types
Available values:APPLY_TO_ORDER, APPLY_TO_ITEMS