Promotion Input

Input representation details of a promotion.
JSON example for POST and PUT
1
2{
3  "promotionDetails": {
4      "name": "Sample Promotion 6",
5      "displayName": "Sample Promotion",
6      "priorityNumber": 1,
7      "description": "Sample promotion description",
8      "promotionCode": "XYZ",
9      "startDateTime": "2023-06-30T00:00:00.000Z",
10      "endDateTime": "2023-12-30T00:00:00.000Z",
11      "objective": "To increase sales",
12      "isAutomatic": true,
13      "loyaltyProgram": {
14        "name":"NTO"
15      },
16      "additionalFieldValues": {
17          "attributes": {
18              "isUnifiedPromotion__c": true
19          }  
20      },
21      "promotionEligibility":{
22          "productCatalog": {
23              "id":"0ZSxx000000001dGAA"
24          },
25          "eligibleProductCategories": [
26              {
27                  "id": "0ZGxx0000000001GAA"
28              }
29          ],
30          "eligibleProducts": [
31              {
32                  "name": "someProduct"
33              }
34          ],
35          "eligibleChannels": [
36              {
37                  "channelType": "***",
38                  "channel": {
39                      "id": "***",
40                      "name": "***"
41                  },
42                  "store": {
43                      "id": "***",
44                      "name": "***"
45                  },
46                  "retailLocationGroup": {
47                      "name": "***"
48                  }
49              }
50          ],
51          "eligibleCampaign": {
52              "name": "***"
53          },
54          "eligibleSegments": [
55              {
56                  "name": "someSegment"
57              }
58          ],
59          "eligibleCustomerEvents":{
60              "event": "MemberBirthday",
61              "eventPeriodUnit": ""
62          },
63          "eligibleEnrollmentPeriod": {
64              "isEnrollmentRequired": true,
65              "enrollmentStartDate": "",
66              "enrollmentEndDate": ""
67          },
68          "eligibleLoyaltyPartnerProducts": [
69              {
70                  "name": "",
71                  "id": ""
72              }
73          ],
74          "eligibleLoyaltyTiers": [
75              {
76                  "tierGroup": {
77                      "name": "",
78                      "id": ""
79                  }, 
80                  "tier": {
81                      "name": "",
82                      "id": ""
83                  }
84              }
85          ],
86          "eligibleCoupons": [
87              {
88                  "couponCode": "",
89                  "status": "",
90                  "description": "",
91                  "startDateTime": "",
92                  "endDateTime": "",
93                  "redemptionLimitOverall": "",
94                  "redemptionLimitPerCustomer": ""
95              }
96          ]
97      },
98      "promotionLimits":{
99          "perLineItemLimit": 10,
100          "pointsPerCustomerLimit": 5,
101          "vouchersPerCustomerLimit": 5,
102          "perCartLimit": 5,
103          "usePerCustomerLimit" : 5,
104          "totalUseLimit" : 25,
105          "pointsLimit": 1000,
106          "vouchersLimit": 100,
107          "liabilityLimit": 10000,
108          "loyaltyProgramCurrency": {
109              "id":"0lcxx0000000001AAA"
110          }
111      }
112  },
113  "rules": [
114        {
115            "templateName": "BuyXToGetRewards",
116            "ruleName": "123",
117            "priority": 1,
118            "eventConfiguration": [
119                {
120                    "allOf": [
121                        {
122                            "anyOf": {
123                                "purchaseType": "Product",
124                                "applicablePurchaseList": [
125                                    {
126                                        "name": "Veg Burger"
127                                    }
128                                ],
129                                "purchaseCriteria": {
130                                    "type": "Quantity",
131                                    "value": 1
132                                }
133                            }
134                        }
135                    ]
136                }
137            ],
138            "rewardConfiguration": [
139                {
140                    "type": "ProvideDiscount",
141                    "rewardDetails": {
142                        "discountValue": "100",
143                        "discountType": "PercentageOff"
144                    },
145                    "targetAudience": {
146                        "audienceType": "LoyaltyTierMembers",
147                        "audienceDetails": {
148                            "tierGroup": {
149                                "name": "Default"
150                            },
151                            "tier": {
152                                "name": "Silver"
153                            }
154                        }
155                    }
156                },
157                {
158                    "type": "IssueVoucher",
159                    "rewardDetails": {
160                        "voucherDefinition": {
161                        "name": "GET 10% OFF"
162                        },
163                        "voucherExpirationDate": "2020-10-10"
164                    },
165                    "targetAudience": {
166                        "audienceType": "AllLoyaltyMembers"
167                    }
168                }
169            ]
170        }
171    ]
172
173}
Properties
Name Type Description Required or Optional Available Version
promotionDetails Unified Promotions Input[] Configuration of the promotion Required 64.0
rules Unified Promotion Template Input[] List of rules that are configured for a promotion. Required 64.0