listTransactions( )

Retrieves a list of transactions for a specified loyalty account.

The listTransactions() function returns a Promise that resolves to a list of loyalty transactions for the loyalty account specified by the account ID.

Loyalty transactions include activities that change a loyalty account point balance, such as adjusting, earning, or redeeming loyalty points. If you want to get a specific transaction use that transaction's ID and the getTransaction() function.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Loyalty
Manage Loyalty
Learn more about permission scopes.
Method Declaration
Method Parameters

Loyalty account ID.


Options to use when retrieving a list of loyalty transactions.

Return Type:Promise<ListTransactionsResponse>
Was this helpful?