Transaction History

Get transaction journals of a loyalty member belonging to a loyalty program. Obtain either accrual or redemption transaction journal records.
Resource
/connect/loyalty/programs/${programName}/transaction-history
Example
https://yourInstance.salesforce.com/services/data/v63.0/connect/loyalty/programs/NTO/transaction-history?page=2
Available version
56.0
Requires Chatter
No
HTTP methods
POST
Request parameters for POST
Parameter Name Type Description Required or Optional Available Version
programName String Name of the loyalty program. Required 56.0
page Integer Number of the page you want returned. If you don’t specify a value, the first page is returned.

By default, each page contains 200 records.

Note

Optional 56.0
Request body for POST
JSON example
{
   "membershipNumber":"doc_member1",
   "journalType":"Accrual",
   "journalSubType":"Social",
   "periodStartDate":"2022-01-27T00:00:00Z",
   "periodEndDate":"2022-11-27T00:00:00Z"
}
Properties
Name Type Description Required or Optional Available Version
journalSubType String The subtype of the transaction journal record. Optional 56.0
journalType String The type of the transaction journal.
Possible values include:
  • Accrual
  • Redemption
Required 56.0
membershipNumber String The membership number of the loyalty program member. Required 56.0
periodEndDate String Retrieve transaction journals until this date. Optional 56.0
periodStartDate String Retrieve transaction journals starting on this date. Required 56.0
Response body for POST
Loyalty View Transaction Journal History Output