Loyalty Management Developer Guide
jPromotion Configuration
Output representation of the promotion’s details and its configuration.
- JSON Example
-
1{ 2 "apiExecutedDateTime": "2024-05-29T09:02:38.809Z", 3 "promotionDetails": { 4 "additionalFieldValues": { 5 "attributes": {} 6 }, 7 "displayName": "Tea Time", 8 "endDateTime": "2024-07-31T08:58:00.000Z", 9 "name": "Tea Time", 10 "priorityNumber": 1, 11 "promotionCode": "TEATIME", 12 "promotionLimits": {}, 13 "startDateTime": "2024-05-01T08:58:00.000Z" 14 }, 15 "promotionLastModifiedDateTime": "2024-05-29T09:01:51.000Z", 16 "promotionRuleList": [ 17 { 18 "apiName": "Eligibility_Rule_Unified_Promotions_0c8xx000000034L", 19 "isEligibilityRule": true, 20 "name": "Eligibility_Rule_Unified_Promotions_0c8xx000000034L_v1", 21 "ruleActionList": [], 22 "ruleFilterCriteriaList": [ 23 { 24 "conditionLogic": "1", 25 "name": "FilterCriteria1", 26 "ruleActionList": [], 27 "ruleConditionList": [ 28 { 29 "operator": "Equals", 30 "parameterName": "CurrencyISOCode", 31 "sequenceNumber": 1, 32 "valueList": [ 33 "USD" 34 ], 35 "valueType": "Literal" 36 } 37 ], 38 "sequenceNumber": 1, 39 "type": "Exists" 40 }, 41 { 42 "conditionLogic": "1 AND 2", 43 "name": "FilterCriteria2", 44 "parentFilterCriteria": "FilterCriteria1", 45 "ruleActionList": [], 46 "ruleConditionList": [ 47 { 48 "operator": "GreaterThanOrEquals", 49 "parameterName": "ActivityStartDateTime", 50 "sequenceNumber": 1, 51 "valueList": [ 52 "2024-05-01 08:58:00" 53 ], 54 "valueType": "Literal" 55 }, 56 { 57 "operator": "LessThanOrEquals", 58 "parameterName": "ActivityStartDateTime", 59 "sequenceNumber": 2, 60 "valueList": [ 61 "2024-07-31 08:58:00" 62 ], 63 "valueType": "Literal" 64 } 65 ], 66 "sequenceNumber": 2, 67 "type": "Exists" 68 }, 69 { 70 "conditionLogic": "1 AND 2", 71 "name": "FilterCriteria3", 72 "parentFilterCriteria": "FilterCriteria2", 73 "ruleActionList": [], 74 "ruleConditionList": [ 75 { 76 "operator": "Equals", 77 "parameterName": "ProductCatalog", 78 "sequenceNumber": 1, 79 "valueList": [ 80 "Beverages" 81 ], 82 "valueType": "Literal" 83 }, 84 { 85 "operator": "In", 86 "parameterName": "EligibleCartLineProduct", 87 "sequenceNumber": 2, 88 "valueList": [ 89 "Tea" 90 ], 91 "valueType": "Literal" 92 } 93 ], 94 "sequenceNumber": 3, 95 "type": "Exists" 96 } 97 ], 98 "ruleParameterList": [ 99 { 100 "contextTag": "cartLineProductCatalogId", 101 "dataType": "Text", 102 "decimalPlaces": 0, 103 "hasContextTagMapping": true, 104 "isCollection": true, 105 "isInput": true, 106 "isOutput": false, 107 "name": "ProductCatalog", 108 "type": "Tag" 109 }, 110 { 111 "contextTag": "activityStartDate", 112 "dataType": "DateTime", 113 "decimalPlaces": 0, 114 "hasContextTagMapping": true, 115 "isCollection": true, 116 "isInput": true, 117 "isOutput": false, 118 "name": "ActivityStartDateTime", 119 "type": "Tag" 120 }, 121 { 122 "contextTag": "currencyISOCode", 123 "dataType": "Text", 124 "decimalPlaces": 0, 125 "hasContextTagMapping": true, 126 "isCollection": true, 127 "isInput": true, 128 "isOutput": false, 129 "name": "CurrencyISOCode", 130 "type": "Tag" 131 }, 132 { 133 "contextTag": "cartLineProductId", 134 "dataType": "Text", 135 "decimalPlaces": 0, 136 "hasContextTagMapping": true, 137 "isCollection": true, 138 "isInput": true, 139 "isOutput": false, 140 "name": "EligibleCartLineProduct", 141 "type": "Tag" 142 } 143 ], 144 "sequenceNumber": 2147483647 145 }, 146 { 147 "apiName": "DiscountTea10Unified_Promotions_0c8xx000000034L", 148 "isEligibilityRule": false, 149 "name": "DiscountTea10Unified_Promotions_0c8xx000000034L_v1", 150 "ruleActionList": [], 151 "ruleFilterCriteriaList": [ 152 { 153 "conditionLogic": "1", 154 "name": "FinalFilterCriteria", 155 "ruleActionList": [], 156 "ruleConditionList": [ 157 { 158 "operator": "GreaterThanOrEquals", 159 "parameterName": "TransactionAmount", 160 "sequenceNumber": 1, 161 "valueList": [ 162 "25.0" 163 ], 164 "valueType": "Literal" 165 } 166 ], 167 "sequenceNumber": 1, 168 "type": "Exists" 169 }, 170 { 171 "conditionLogic": "1", 172 "name": "NonLoyaltyMemberCriteria", 173 "parentFilterCriteria": "BranchCriteria", 174 "ruleActionList": [ 175 { 176 "actionType": "SetValue", 177 "name": "pricingReward1", 178 "ruleActionParameterList": [ 179 { 180 "name": "type", 181 "sequenceNumber": 1, 182 "value": "ProvideDiscount", 183 "valueType": "Literal" 184 }, 185 { 186 "name": "discountLevel", 187 "sequenceNumber": 2, 188 "value": "Cart", 189 "valueType": "Literal" 190 }, 191 { 192 "name": "discountValue", 193 "sequenceNumber": 3, 194 "value": "10.0", 195 "valueType": "Literal" 196 }, 197 { 198 "name": "discountType", 199 "sequenceNumber": 4, 200 "value": "PercentageOff", 201 "valueType": "Literal" 202 } 203 ], 204 "sequenceNumber": 1 205 } 206 ], 207 "ruleConditionList": [ 208 { 209 "operator": "GreaterThanOrEquals", 210 "parameterName": "ActivityStartDateTime", 211 "sequenceNumber": 1, 212 "valueList": [ 213 "1970-01-01 08:00:00" 214 ], 215 "valueType": "Literal" 216 } 217 ], 218 "sequenceNumber": 3, 219 "type": "Exists" 220 }, 221 { 222 "name": "BranchCriteria", 223 "parentFilterCriteria": "FinalFilterCriteria", 224 "ruleActionList": [], 225 "ruleConditionList": [], 226 "sequenceNumber": 2, 227 "type": "Branch" 228 } 229 ], 230 "ruleParameterList": [ 231 { 232 "contextTag": "transactionAmount", 233 "dataType": "Currency", 234 "decimalPlaces": 0, 235 "hasContextTagMapping": true, 236 "isCollection": true, 237 "isInput": true, 238 "isOutput": false, 239 "name": "TransactionAmount", 240 "type": "Tag" 241 }, 242 { 243 "dataType": "Text", 244 "decimalPlaces": 0, 245 "hasContextTagMapping": false, 246 "isCollection": false, 247 "isInput": false, 248 "isOutput": true, 249 "name": "discountLevel", 250 "type": "Variable" 251 }, 252 { 253 "dataType": "Text", 254 "decimalPlaces": 0, 255 "hasContextTagMapping": false, 256 "isCollection": false, 257 "isInput": false, 258 "isOutput": true, 259 "name": "discountType", 260 "type": "Variable" 261 }, 262 { 263 "contextTag": "activityStartDate", 264 "dataType": "DateTime", 265 "decimalPlaces": 0, 266 "hasContextTagMapping": true, 267 "isCollection": true, 268 "isInput": true, 269 "isOutput": false, 270 "name": "ActivityStartDateTime", 271 "type": "Tag" 272 }, 273 { 274 "dataType": "Text", 275 "decimalPlaces": 0, 276 "hasContextTagMapping": false, 277 "isCollection": false, 278 "isInput": false, 279 "isOutput": true, 280 "name": "type", 281 "type": "Variable" 282 }, 283 { 284 "dataType": "Numeric", 285 "decimalPlaces": 0, 286 "hasContextTagMapping": false, 287 "isCollection": false, 288 "isInput": false, 289 "isOutput": true, 290 "name": "discountValue", 291 "type": "Variable" 292 } 293 ], 294 "sequenceNumber": 1 295 }, 296 { 297 "apiName": "TeaAndCoffeeDiscount10Unified_Promotions_0c8xx000000034L", 298 "isEligibilityRule": false, 299 "name": "TeaAndCoffeeDiscount10Unified_Promotions_0c8xx000000034L_v1", 300 "ruleActionList": [], 301 "ruleFilterCriteriaList": [ 302 { 303 "conditionLogic": "1", 304 "name": "NonLoyaltyMemberCriteria", 305 "parentFilterCriteria": "BranchCriteria", 306 "ruleActionList": [ 307 { 308 "actionType": "SetValue", 309 "name": "pricingLineLevelReward1", 310 "ruleActionParameterList": [ 311 { 312 "name": "type", 313 "sequenceNumber": 1, 314 "value": "ProvideDiscount", 315 "valueType": "Literal" 316 }, 317 { 318 "name": "discountType", 319 "sequenceNumber": 2, 320 "value": "PercentageOff", 321 "valueType": "Literal" 322 }, 323 { 324 "name": "discountLevel", 325 "sequenceNumber": 3, 326 "value": "Line", 327 "valueType": "Literal" 328 }, 329 { 330 "name": "discountValue", 331 "sequenceNumber": 4, 332 "value": "10.0", 333 "valueType": "Literal" 334 }, 335 { 336 "name": "discountProduct", 337 "sequenceNumber": 5, 338 "value": "Tea", 339 "valueType": "Literal" 340 }, 341 { 342 "name": "discountProductId", 343 "sequenceNumber": 6, 344 "value": "Tea", 345 "valueType": "Literal" 346 }, 347 { 348 "name": "discountAppliedAt", 349 "sequenceNumber": 7, 350 "value": "LineItem", 351 "valueType": "Literal" 352 } 353 ], 354 "sequenceNumber": 1 355 }, 356 { 357 "actionType": "SetValue", 358 "name": "pricingLineLevelReward2", 359 "ruleActionParameterList": [ 360 { 361 "name": "type", 362 "sequenceNumber": 1, 363 "value": "ProvideDiscount", 364 "valueType": "Literal" 365 }, 366 { 367 "name": "discountType", 368 "sequenceNumber": 2, 369 "value": "PercentageOff", 370 "valueType": "Literal" 371 }, 372 { 373 "name": "discountLevel", 374 "sequenceNumber": 3, 375 "value": "Line", 376 "valueType": "Literal" 377 }, 378 { 379 "name": "discountValue", 380 "sequenceNumber": 4, 381 "value": "10.0", 382 "valueType": "Literal" 383 }, 384 { 385 "name": "discountProduct", 386 "sequenceNumber": 5, 387 "value": "Coffee", 388 "valueType": "Literal" 389 }, 390 { 391 "name": "discountProductId", 392 "sequenceNumber": 6, 393 "value": "Coffee", 394 "valueType": "Literal" 395 }, 396 { 397 "name": "discountAppliedAt", 398 "sequenceNumber": 7, 399 "value": "LineItem", 400 "valueType": "Literal" 401 } 402 ], 403 "sequenceNumber": 2 404 } 405 ], 406 "ruleConditionList": [ 407 { 408 "operator": "GreaterThanOrEquals", 409 "parameterName": "ActivityStartDateTime", 410 "sequenceNumber": 1, 411 "valueList": [ 412 "1970-01-01 08:00:00" 413 ], 414 "valueType": "Literal" 415 } 416 ], 417 "sequenceNumber": 4, 418 "type": "Exists" 419 }, 420 { 421 "conditionLogic": "1", 422 "name": "ProductFilter1", 423 "ruleActionList": [], 424 "ruleConditionList": [ 425 { 426 "operator": "In", 427 "parameterName": "CartLineProduct", 428 "sequenceNumber": 1, 429 "valueList": [ 430 "Tea" 431 ], 432 "valueType": "Literal" 433 } 434 ], 435 "sequenceNumber": 1, 436 "type": "Loop" 437 }, 438 { 439 "name": "BranchCriteria", 440 "parentFilterCriteria": "FinalFilterCriteria", 441 "ruleActionList": [], 442 "ruleConditionList": [], 443 "sequenceNumber": 3, 444 "type": "Branch" 445 }, 446 { 447 "conditionLogic": "1", 448 "name": "FinalFilterCriteria", 449 "ruleActionList": [], 450 "ruleConditionList": [ 451 { 452 "matchType": "Any", 453 "operator": "GreaterThanOrEquals", 454 "parameterName": "FilterProducts1", 455 "sequenceNumber": 1, 456 "valueList": [ 457 "6.0" 458 ], 459 "valueType": "Literal" 460 } 461 ], 462 "sequenceNumber": 2, 463 "type": "Exists" 464 } 465 ], 466 "ruleParameterList": [ 467 { 468 "dataType": "Text", 469 "decimalPlaces": 0, 470 "hasContextTagMapping": false, 471 "isCollection": false, 472 "isInput": false, 473 "isOutput": true, 474 "name": "discountLevel", 475 "type": "Variable" 476 }, 477 { 478 "dataType": "Text", 479 "decimalPlaces": 0, 480 "hasContextTagMapping": false, 481 "isCollection": false, 482 "isInput": false, 483 "isOutput": true, 484 "name": "discountProduct", 485 "type": "Variable" 486 }, 487 { 488 "dataType": "Text", 489 "decimalPlaces": 0, 490 "hasContextTagMapping": false, 491 "isCollection": false, 492 "isInput": false, 493 "isOutput": true, 494 "name": "discountProductId", 495 "type": "Variable" 496 }, 497 { 498 "dataType": "Text", 499 "decimalPlaces": 0, 500 "hasContextTagMapping": false, 501 "isCollection": false, 502 "isInput": false, 503 "isOutput": true, 504 "name": "discountType", 505 "type": "Variable" 506 }, 507 { 508 "contextTag": "activityStartDate", 509 "dataType": "DateTime", 510 "decimalPlaces": 0, 511 "hasContextTagMapping": true, 512 "isCollection": true, 513 "isInput": true, 514 "isOutput": false, 515 "name": "ActivityStartDateTime", 516 "type": "Tag" 517 }, 518 { 519 "contextTag": "cartLineProductId", 520 "dataType": "Text", 521 "decimalPlaces": 0, 522 "hasContextTagMapping": true, 523 "isCollection": true, 524 "isInput": true, 525 "isOutput": false, 526 "name": "CartLineProduct", 527 "type": "Tag" 528 }, 529 { 530 "dataType": "Text", 531 "decimalPlaces": 0, 532 "hasContextTagMapping": false, 533 "isCollection": false, 534 "isInput": false, 535 "isOutput": true, 536 "name": "type", 537 "type": "Variable" 538 }, 539 { 540 "dataType": "Numeric", 541 "decimalPlaces": 0, 542 "hasContextTagMapping": false, 543 "isCollection": false, 544 "isInput": false, 545 "isOutput": true, 546 "name": "discountValue", 547 "type": "Variable" 548 }, 549 { 550 "aggregateFunction": "Sum", 551 "dataType": "Tuple", 552 "decimalPlaces": 0, 553 "groupByContextTag": "cartLineProductId", 554 "hasContextTagMapping": true, 555 "isCollection": true, 556 "isInput": true, 557 "isOutput": true, 558 "name": "FilterProducts1", 559 "relatedFilterCriteriaName": "ProductFilter1", 560 "type": "Accumulate", 561 "value": "cartLineItemQuantity" 562 }, 563 { 564 "dataType": "Text", 565 "decimalPlaces": 0, 566 "hasContextTagMapping": false, 567 "isCollection": false, 568 "isInput": false, 569 "isOutput": true, 570 "name": "discountAppliedAt", 571 "type": "Variable" 572 } 573 ], 574 "sequenceNumber": 2 575 } 576 ], 577 "relatedRuleLibrary": { 578 "apiName": "GPMRuleLibrary", 579 "description": "GPMRuleLibrary", 580 "name": "GPMRuleLibrary_v1", 581 "relatedContextDefinitionDeveloperName": "GPMContext" 582 } 583}
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| apiExecutedDateTime | String | The date and time on which the API was executed. | Small, 61.0 | 61.0 |
| promotionDetails | Unified Promotions Output[] | The details of the promotion. | Small, 61.0 | 61.0 |
| promotionLastModifiedDateTime | String | The date and time on which the promotion was last modified. | Small, 61.0 | 61.0 |
| promotionRuleList | Promotion Rule[] | The rules of the promotion. The rules are represented as context rules in the response. | Small, 61.0 | 61.0 |
| relatedRuleLibrary | Rule Library[] | The rule library that's associated with the promotion. | Small, 61.0 | 61.0 |