Newer Version Available

This content describes an older version of this product. View Latest

Applied Cart Promotion Details

The details of the cart-level promotions applied to the cart.
JSON example
This example shows a sample response.
1
2        "appliedCartPromotionDetails": [
3          {
4            "cartAmountAfterDiscount": 99.5,
5            "cartAmountBeforeDiscount": 99.5,
6            "cartLevelDiscountAmount": 0,
7            "displayName": "Get 10% off on Burger + Voucher",
8            "isAutomatic": true,
9            "nonPricingRewards": {
10              "voucherRewards": [
11                {
12                  "voucherDefinitionId": "2Xaxx00000000XtCAI",
13                  "voucherDefinitionName": "Voucher1"
14                }
15              ]
16            },
17            "promotionId": "0c8xx00000004y5AAA"
18          },
19          {
20            "cartAmountAfterDiscount": 89.5,
21            "cartAmountBeforeDiscount": 99.5,
22            "cartLevelDiscountAmount": 10,
23            "displayName": "10% off on Cart",
24            "isAutomatic": true,
25            "nonPricingRewards": {},
26            "promotionId": "0c8xx00000005R7AAI"
27          },
28          {
29            "cartAmountAfterDiscount": 99.5,
30            "cartAmountBeforeDiscount": 99.5,
31            "cartLevelDiscountAmount": 0,
32            "displayName": "Cart Voucher",
33            "isAutomatic": true,
34            "nonPricingRewards": {
35              "voucherRewards": [
36                {
37                  "voucherDefinitionId": "2Xaxx00000000XtCAI",
38                  "voucherDefinitionName": "Voucher1"
39                }
40              ]
41            },
42            "promotionId": "0c8xx000000060bAAA"
43          },
44          {
45            "cartAmountAfterDiscount": 79.5,
46            "cartAmountBeforeDiscount": 99.5,
47            "cartLevelDiscountAmount": 20,
48            "isAutomatic": true,
49            "nonPricingRewards": {},
50            "promotionId": "0c8xx00000006wfAAA"
51          },
52          {
53            "cartAmountAfterDiscount": 99.5,
54            "cartAmountBeforeDiscount": 99.5,
55            "cartLevelDiscountAmount": 0,
56            "displayName": "LOY promotion",
57            "isAutomatic": true,
58            "nonPricingRewards": {
59              "badgeRewards": [
60                {
61                  "loyaltyProgramBadgeId": "0w8xx0000000001AAA",
62                  "badgeValidityEndDate": "2025-08-31T00:00:00.000Z",
63                  "loyaltyProgramBadgeName": "badge1"
64                }
65              ],
66              "fixedPointsRewards": [
67                {
68                  "loyaltyProgramCurrencyName": "NQP",
69                  "loyaltyProgramCurrencyId": "0lcxx00000001FRAAY",
70                  "points": 100
71                }
72              ]
73            },
74            "promotionId": "0c8xx0000000EpNAAU"
75          },
76          {
77            "cartAmountAfterDiscount": 99.5,
78            "cartAmountBeforeDiscount": 99.5,
79            "cartLevelDiscountAmount": 0,
80            "isAutomatic": true,
81            "nonPricingRewards": {
82              "multiplierPointsRewards": [
83                {
84                  "loyaltyProgramCurrencyName": "NQP",
85                  "pointsExpirationDate": "2025-09-07T00:00:00.000Z",
86                  "transactionJournalField": "TransactionJournal.TransactionAmount",
87                  "loyaltyProgramCurrencyId": "0lcxx00000001FRAAY",
88                  "multiplierValue": 44
89                }
90              ],
91              "gameRewards": [
92                {
93                  "gameDefinitionId": "3GDxx0000004C92GAE",
94                  "gameType": "Scratchcard",
95                  "gameDefinitionName": "GD1"
96                }
97              ]
98            },
99            "promotionId": "0c8xx0000000Fv7AAE"
100          }
101        ]
Property Name Type Description Filter Group and Version Available Version
cartAmount​AfterDiscount Double The updated cart amount after the current promotion is applied. Big, 65.0 65.0
cartAmount​BeforeDiscount Double Cart amount before the current promotion is applied. Big, 65.0 65.0
cartLevel​DiscountAmount Double Total amount of discounts from promotions. Big, 65.0 65.0
couponCode String Coupon code of the applied promotion. Big, 65.0 65.0
currencyIsoCode String Three-letter ISO 4217 code of the monetary currency assoaicted with the applied promotion. Big, 65.0 65.0
displayName String Display name of the applied promotion. Big, 65.0 65.0
isAutomatic Boolean Indicates whether the promotion is automatically applied for eligible carts (true) or not (false). Big, 65.0 65.0
nonPricing​Rewards Map<String, Object> The non-pricing rewards issued to customers as a part of the applied promotions. Possible rewards are:
  • badgeRewards: List of rewards for members in the form of badges.
  • fixedPointsRewards: List of rewards for members in the form of fixed number of loyalty points.
  • gameRewards: List of rewards in the form of games.
  • multiplierPointsRewards: List of rewards for members in the form of loyalty points that are calculated based on a multiplier and a transaction journal field.
  • voucherRewards: List of rewards in the form of vouchers.
Big, 65.0 65.0
promotionCode String Code of the applied promotion. Big, 65.0 65.0
promotionId String The ID of the applied promotion. Big, 65.0 65.0