Newer Version Available
Eligible Promotions List
Output representation of a list of eligible promotions.
- JSON example
-
1{ 2 "promotions": [ 3 { 4 "id": "0c85i0000009c6D", 5 "promotionCode": "10OFF", 6 "displayName": "10% off on all electronics", 7 "priority": 1, 8 "currencyCode": "USD", 9 "coupon": { 10 "couponDetails": { 11 "couponCode": "COUPON-123", 12 "status": "Active", 13 "startDateTime": "2024-01-01", 14 "endDateTime": null 15 }, 16 "message": "SingleActive" 17 }, 18 "isAutomatic" : false, 19 "additionalFields": { 20 "startDate": "2023-09-10", 21 "endDate": "2023-09-20", 22 "promotionLocation__c": "HYD" 23 }, 24 "limits": [ 25 { 26 "type": "PerLineItem", 27 "limit": 1 28 } 29 ], 30 "rules": [ 31 { 32 "ruleName": "10PercentElectronics", 33 "benefits": [ 34 { 35 "type": "Discount", 36 "discountLevel": "Cart", 37 "discountType": "Amount", 38 "discountValue": 10 39 }, 40 { 41 "type": "Discount", 42 "discountLevel": "CartLineItem", 43 "lines": [ 44 { 45 "id": "6c139faa-b749-11ed-afa1-0242ac120002", 46 "quantity": 3 47 }, 48 { 49 "id": "346bded6-b74a-11ed-afa1-0242ac120002", 50 "quantity": 2 51 } 52 ], 53 "discountType": "Amount", 54 "discountValue": 10 55 }, 56 { 57 "type": "Voucher", 58 "voucherDefinition": "ELEC10", 59 "voucherExpiryDate": "2023-12-31" 60 } 61 ] 62 }, 63 { 64 "ruleName": "5PercentAppliances", 65 "benefits": [ 66 { 67 "type": "Discount", 68 "discountLevel": "Cart", 69 "discountType": "Percent", 70 "discountValue": 5 71 }, 72 { 73 "type": "FreeProduct", 74 "lineItemid": "b749-11ed-afa1", 75 "lines": [ 76 { 77 "id": "6c139faa-b749-11ed-afa1-0242ac120002", 78 "quantity": 1 79 } 80 ] 81 } 82 ] 83 } 84 ] 85 }, 86 { 87 "id": "0c85i0000009c6D", 88 "promotionCode": "20OFF", 89 "displayName": "Get 100 points on all clothing", 90 "priority": 2, 91 "currencyCode": "USD", 92 "additionalFields": { 93 "startDate": "2023-09-10" 94 }, 95 "rules": [ 96 { 97 "ruleName": "100PointsClothing", 98 "benefits": [ 99 { 100 "type": "Points", 101 "points": "10", 102 "loyaltyProgramCurrencyName": "NQP" 103 }, 104 { 105 "type": "Badge", 106 "loyaltyProgramBadgeName": "Ranger" 107 } 108 ] 109 } 110 ] 111 } 112 ] 113}
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| Promotions | Promotion Details[] | List of promotions that are eligible for a customer's cart. The list also contains the details of the rewards that each promotion offers to the customer. | Small, 60.0 | 60.0 |