Transaction History

Get transaction journals of a loyalty member belonging to a loyalty program. Obtain either accrual or redemption transaction journal records.

Resource 

1/connect/loyalty/programs/${programName}/transaction-history

Example 

1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/connect/loyalty/programs/NTO/transaction-history?page=2

Available Version 

56.0

Requires Chatter 

No

HTTP Methods 

POST

Request Parameters for POST 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
programNameStringName of the loyalty program.Required56.0
pageIntegerNumber of the page you want returned. If you don’t specify a value, the first page is returned.Optional56.0

Note: By default, each page contains 200 records.

Request Body for POST 

JSON Example

1{
2   "membershipNumber":"doc_member1",
3   "journalType":"Accrual",
4   "journalSubType":"Social",
5   "periodStartDate":"2022-01-27T00:00:00Z",
6   "periodEndDate":"2022-11-27T00:00:00Z"
7}

Properties

NameTypeDescriptionRequired or OptionalAvailable Version
journalSubTypeStringThe subtype of the transaction journal record.Optional56.0
journalTypeStringThe type of the transaction journal. Possible values include Accrual or Redemption.Required56.0
membershipNumberStringThe membership number of the loyalty program member.Required56.0
periodEndDateStringRetrieve transaction journals until this date.Optional56.0
periodStartDateStringRetrieve transaction journals starting on this date.Required56.0

Response Body for POST 

Loyalty View Transaction Journal History Output