Newer Version Available

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

Cart Details

The details of the cart and its line items, including initial amount, adjusted price, and details of all applied discounts and promotions.
JSON example
This example shows a sample response.
1{
2    "cartDetails": [
3      {
4        "adjustedCartAmount": 69.5,
5        "appliedCartPromotionDetails": [
6          {
7            "cartAmountAfterDiscount": 99.5,
8            "cartAmountBeforeDiscount": 99.5,
9            "cartLevelDiscountAmount": 0,
10            "displayName": "Get 10% off on Burger + Voucher",
11            "isAutomatic": true,
12            "nonPricingRewards": {
13              "voucherRewards": [
14                {
15                  "voucherDefinitionId": "2Xaxx00000000XtCAI",
16                  "voucherDefinitionName": "Voucher1"
17                }
18              ]
19            },
20            "promotionId": "0c8xx00000004y5AAA"
21          },
22          {
23            "cartAmountAfterDiscount": 89.5,
24            "cartAmountBeforeDiscount": 99.5,
25            "cartLevelDiscountAmount": 10,
26            "displayName": "10% off on Cart",
27            "isAutomatic": true,
28            "nonPricingRewards": {},
29            "promotionId": "0c8xx00000005R7AAI"
30          },
31          {
32            "cartAmountAfterDiscount": 99.5,
33            "cartAmountBeforeDiscount": 99.5,
34            "cartLevelDiscountAmount": 0,
35            "displayName": "Cart Voucher",
36            "isAutomatic": true,
37            "nonPricingRewards": {
38              "voucherRewards": [
39                {
40                  "voucherDefinitionId": "2Xaxx00000000XtCAI",
41                  "voucherDefinitionName": "Voucher1"
42                }
43              ]
44            },
45            "promotionId": "0c8xx000000060bAAA"
46          },
47          {
48            "cartAmountAfterDiscount": 79.5,
49            "cartAmountBeforeDiscount": 99.5,
50            "cartLevelDiscountAmount": 20,
51            "isAutomatic": true,
52            "nonPricingRewards": {},
53            "promotionId": "0c8xx00000006wfAAA"
54          },
55          {
56            "cartAmountAfterDiscount": 99.5,
57            "cartAmountBeforeDiscount": 99.5,
58            "cartLevelDiscountAmount": 0,
59            "displayName": "LOY promotion",
60            "isAutomatic": true,
61            "nonPricingRewards": {
62              "badgeRewards": [
63                {
64                  "loyaltyProgramBadgeId": "0w8xx0000000001AAA",
65                  "badgeValidityEndDate": "2025-08-31T00:00:00.000Z",
66                  "loyaltyProgramBadgeName": "badge1"
67                }
68              ],
69              "fixedPointsRewards": [
70                {
71                  "loyaltyProgramCurrencyName": "NQP",
72                  "loyaltyProgramCurrencyId": "0lcxx00000001FRAAY",
73                  "points": 100
74                }
75              ]
76            },
77            "promotionId": "0c8xx0000000EpNAAU"
78          },
79          {
80            "cartAmountAfterDiscount": 99.5,
81            "cartAmountBeforeDiscount": 99.5,
82            "cartLevelDiscountAmount": 0,
83            "isAutomatic": true,
84            "nonPricingRewards": {
85              "multiplierPointsRewards": [
86                {
87                  "loyaltyProgramCurrencyName": "NQP",
88                  "pointsExpirationDate": "2025-09-07T00:00:00.000Z",
89                  "transactionJournalField": "TransactionJournal.TransactionAmount",
90                  "loyaltyProgramCurrencyId": "0lcxx00000001FRAAY",
91                  "multiplierValue": 44
92                }
93              ],
94              "gameRewards": [
95                {
96                  "gameDefinitionId": "3GDxx0000004C92GAE",
97                  "gameType": "Scratchcard",
98                  "gameDefinitionName": "GD1"
99                }
100              ]
101            },
102            "promotionId": "0c8xx0000000Fv7AAE"
103          }
104        ],
105        "cartHeaderId": "01ddf0000003kfMAAW",
106        "cartLineDetails": [
107          {
108            "appliedCartLinePromotionDetails": [
109              {
110                "cartLineItemAmountAfterDiscount": 95,
111                "cartLineItemAmountBeforeDiscount": 100,
112                "cartLineItemDiscountAmount": 5,
113                "couponCode": "PIZZA5",
114                "currencyIsoCode": "USD",
115                "displayName": "5 % off on Pizza",
116                "isAutomatic": false,
117                "promotionId": "0c8xx00000005NtAAI"
118              }
119            ],
120            "cartLineItemAmountAfterDiscount": 66.36,
121            "cartLineItemAmountBeforeDiscount": 100,
122            "cartLineItemId": "abcd1",
123            "cartLineItemQuantity": 2,
124            "cartLineProduct": "Pizza",
125            "totalCartLineItemDiscountAmount": 33.64,
126            "totalCartLinePromotionsDiscountAmount": 5,
127            "totalCartPromotionsDistributedDiscountAmount": 28.64
128          },
129          {
130            "appliedCartLinePromotionDetails": [
131              {
132                "cartLineItemAmountAfterDiscount": 9,
133                "cartLineItemAmountBeforeDiscount": 10,
134                "cartLineItemDiscountAmount": 1,
135                "currencyIsoCode": "USD",
136                "displayName": "Get 10% off on Burger + Voucher",
137                "isAutomatic": true,
138                "promotionId": "0c8xx00000004y5AAA"
139              },
140              {
141                "cartLineItemAmountAfterDiscount": 4.5,
142                "cartLineItemAmountBeforeDiscount": 9,
143                "cartLineItemDiscountAmount": 4.5,
144                "currencyIsoCode": "USD",
145                "displayName": "Buy 1 Pizza, Get 1 Burger Free",
146                "isAutomatic": true,
147                "promotionId": "0c8xx00000006TdAAI"
148              }
149            ],
150            "cartLineItemAmountAfterDiscount": 3.14,
151            "cartLineItemAmountBeforeDiscount": 10,
152            "cartLineItemId": "abcd2",
153            "cartLineItemQuantity": 2,
154            "cartLineProduct": "Burger",
155            "totalCartLineItemDiscountAmount": 6.86,
156            "totalCartLinePromotionsDiscountAmount": 5.5,
157            "totalCartPromotionsDistributedDiscountAmount": 1.36
158          }
159        ],
160        "initialCartAmount": 110,
161        "totalCartLevelDiscountAmount": 30,
162        "totalDiscountAmount": 40.5,
163        "totalLineLevelDiscountAmount": 10.5
164      }
165    ]
166  }
167}
Property Name Type Description Filter Group and Version Available Version
adjustedCartAmount Double The final total amount of the cart after all promotions are applied. Big, 65.0 65.0
appliedCartPromotionDetails Applied Cart Promotion Details[] Details of the cart-level promotions and non-pricing rewards of the line and cross line level promotions applied to the cart. Big, 65.0 65.0
cartHeaderId String The ID of the cart on which promotions are applied. Big, 65.0 65.0
cartLineDetails Cart Line Details[] Details of the initial amount, adjusted price, and details of all applied discounts and promotions to cart line items within the cart. Big, 65.0 65.0
initialCartAmount Double Sum of the prices of all items in the cart before any promotions are applied. Big, 65.0 65.0
totalCartLevelDiscountAmount Double Total amount of discounts applied to the the cart from cart-level promotions. Big, 65.0 65.0
totalDiscountAmount Double Sum of all discounts applied to the the cart, including line-level, crossline-level and cart-level discounts. Big, 65.0 65.0
totalLineLevelDiscountAmount Double Total amount of discounts applied to line items from line-level and crossline-level promotions. Big, 65.0 65.0