Loyalty Engine Input

Input representation of the Loyalty Engine Runtime API.

Root XML tag

<loyaltyEngineInput>

JSON example

Some of the API request fields contain field names that are interchangeable. For information on the list of interchangeable field names, see Loyalty Management Connect API Interchangeable Request Fields.

Note

1{
2  "transactionJournals": [
3    {
4      "ActivityDate": "2022-01-04T12:45:19Z",
5      "JournalDate": "2022-01-04T00:45:19Z",
6      "Brand": "",
7      "Establishment": "Apple",
8      "ExternalTransactionNumber": "P1-981950",
9      "JournalTypeId": "0lET10000004CQp",
10      "LoyaltyProgramId": "0lpT10000004CdN",
11      "MemberId": "0lMT10000004CfA",
12      "TransactionAmount": "117",
13      "TransactionLocation": "HitechCity",
14      "VoucherCode": "",
15      "Origin": "asdf",
16      "Distance": "5",
17      "Destination": "Hyderabad",
18      "FlightNumber": "SF-Ran-001",
19      "Status": "Pending"
20    }
21  ],
22  "runSetting": {
23    "isSimulation": true
24  }
25}

Using the transaction journal ID:

1{
2  "transactionJournals": [
3    {
4      "Id": "0lVxx00000000cj"
5    }
6  ],
7  "runSetting": {
8    "isSimulation": true
9  }
10}

Properties

Name	Type	Description	Required or Optional	Available Version
`transactionJournals`	Loyalty Engine Input Map	Represents the transaction journals records to process.	Required	54.0
`runSetting`	Loyalty Engine Run Settings Input	Loyalty runtime setting to run the simulation on the transaction journals.	Required for simulation, otherwise optional	55.0

Loyalty Management Developer Guide

Loyalty Engine Input