Loyalty API

List the transactions for a customer

GET

The Loyalty API is currently in beta.

Please contact our Support Team via our JIRA Service Desk for access to the Beta. If you don’t have access, please contact your account administrator for assistance.

Not yet integrated with Primer and interested in learning more? Contact us.

Create an API key with the loyalty-transactions:read scopes.

Get all your loyalty transactions. You can filter by connectionId (recommended) and by customerId and orderId.

Additionally provide a limit to restrict the number of transactions in the response, and an offset to determine where to start.

Query parameters

connectionIdstringOptional
Filter transactions by customer Id.
customerIdstringOptional
Filter transactions by customer Id.
orderIdstringOptional
Filter transactions by orderId.
limitintegerOptional
Limit the number of returned results
offsetintegerOptional
The number of items to skip before returning results

Response

This endpoint returns an object
items
list of objectsOptional
The list of loyalty transactions
total
integerOptional
The total number of available results
limit
integerOptional
The limit of the paged result
offset
integerOptional
The offset of the paged result

Errors