queryLoyaltyTransactions( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of loyalty transactions, given the provided paging, filtering, and sorting.

Supported fields for filtering and sorting: id, accountId, idempotencyKey, transactionType, amount, description

To learn how to query Loyalty Transactions, see API Query Language.

PROPERTY	SUPPORTED FILTERS & SORTING
`_id`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`ascending()`,`descending()`
`accountId`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`ascending()`,`descending()`
`amount`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`lt()`,`le()`,`gt()`,`ge()`,`ascending()`,`descending()`
`transactionType`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`ascending()`,`descending()`
`description`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`ascending()`,`descending()`
`idempotencyKey`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`ascending()`,`descending()`

Admin Method

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

For app development, you must have one of the following permission scopes:

Learn more about permission scopes.

Method Declaration

Copy

Request

This method does not take any parameters

Was this helpful?

Yes