Loyalty Engine Realtime

Output representation of the loyalty program process result.

JSON example

1{
2   "message":null,
3   "processResult":{
4      "memberPointsBalance":[
5         {
6            "memberCurrencies":[
7               {
8                  "currencyName":"Tier Coins",
9                  "currencyType":"Qualifying",
10                  "escrowPointsBalance":0.0,
11                  "pointsBalance":350.0
12               },
13               {
14                  "currencyName":"Coins",
15                  "currencyType":"NonQualifying",
16                  "escrowPointsBalance":0.0,
17                  "pointsBalance":300.0
18               }
19            ],
20            "memberShipNumber":"M5"
21         }
22      ],
23      "transactionJournalResult":[
24         {
25            "badgesAssigned":[
26               {
27                  "badgeValidityEndDate":"2023-12-15",
28                  "loyaltyProgramBadgeName":"Gen AI Badge",
29                  "memberBadgeStatus":"1",
30                  "reason":"Test"
31               }
32            ],
33            "changeInMemberPoints":[
34               {
35                  "changeInMemberCurrencies":[
36                     {
37                        "changeInPointsBalance":100.0,
38                        "currencyName":"Coins",
39                        "currencyType":"NonQualifying",
40                        "promotionId":"0c8RM0000004FiX"
41                     }
42                  ],
43                  "memberShipNumber":"M5"
44               }
45            ],
46            "gamesAssigned":[
47               {
48                  "gameDefinitionName":"3PRRM0000004C98",
49                  "gameExpirationDate":"2023-12-28T00:00:00.000Z",
50                  "reason":"Test"
51               }
52            ],
53            "id":"0lVRM0000002qnB2AQ",
54            "voucherResult":{
55               "vouchersIssued":[
56                  {
57                     "discountPercent":10,
58                     "effectiveDate":"2023-11-29",
59                     "expirationDate":"2023-12-15",
60                     "promotionId":"0c8RM0000004FiX",
61                     "voucherDefinitionName":"10% Discount Voucher"
62                  }
63               ]
64            }
65         }
66      ]
67   },
68   "programName":"NTO",
69   "simulationResults":null,
70   "status":true
71}

Property Name	Type	Description	Filter Group and Version	Available Version
`message`	String	Error message.	Small, 54.0	54.0
`processResult`	Process Result	Details of each transaction journal in a request, and also the member points balance that is the currency-wise balances after all the transaction journals are processed. The process result collection is empty when the simulation is run.	Small, 54.0	54.0
`programName`	String	Name of the loyalty program.	Small, 55.0	55.0
`simulationResults`	Transaction Journal Map Output	Simulation result that details how the loyalty program process rules can process a transaction journal. The simulation result collection is empty when the loyalty program process is run.	Small, 55.0	55.0
`status`	Boolean	Indicates whether the request succeeded (`true`) or failed (`false`).	Small, 54.0	54.0

The response contains only the details of the points, badges, games, and vouchers that are provided by the loyalty program process rules executed for the member's order. The response doesn't contain the details of the rewards provided by the flows or the subprocesses that the loyalty program process rules execute.

Important

Loyalty Management Developer Guide

Loyalty Engine Realtime