Newer Version Available

This content describes an older version of this product. View Latest

Transaction Journals Execution

Use this resource to create and process a list of transaction journals against a corresponding loyalty program process.

The loyalty program processes determine how transaction journals are processed. When transaction journals meet the criteria and conditions for a program process, actions that are set up in the process are triggered for the transaction journals. For more information on how to set up program process, see LoyaltyProgramSetup in Loyalty Management Developer Guide.

Special Access Rules
To use this resource, your org must have either B2C - Loyalty, B2C - Loyalty Plus, Loyalty Management - Growth, or Loyalty Management - Advanced license enabled, and you must be assigned the Loyalty Management permission set.
Resource
1/connect/realtime/loyalty/programs/${programName}
Resource example
1https://yourInstance.salesforce.com/services/data/vXX.X/connect
2/realtime/loyalty/programs/CloudKicksInnerCircle
Available version
54.0
Requires Chatter
No
HTTP methods
POST
Request body for POST
JSON example
In the JSON, you can either provide the details of transaction journals that aren’t available in the org or a list of IDs that belong to transaction journals available in the org. If you provide the details of transaction journals that aren’t available in the org, each transaction journal’s applicable loyalty program process applies the eligible rules, executes the applicable actions, and then creates the transaction journal.

Using the transaction journal details:

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}
Using the transaction journal ID:

This is supported in API version 55.0 and later.

Note

1{
2  "transactionJournals": [
3    {
4      "Id": "0lVxx00000000cj"
5    }
6  ]
7}
Properties
Name Type Description Required or Optional Available Version
processInput Map<String, Object> List of the Transaction Journal records to process and create. Required 54.0
Response body for POST
Loyalty Engine Realtime Output