List the transactions for a customer

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.

limitintegerOptionalDefaults to 50

Limit the number of returned results

offsetintegerOptionalDefaults to 0

The number of items to skip before returning results

Response

Successful Response

itemslist of objects or null

The list of loyalty transactions

totalinteger or null

The total number of available results

limitinteger or null

The limit of the paged result

offsetinteger or null

The offset of the paged result

1	{
2	"items": [
3	{
4	"date": "2023-01-01T12:00:00Z",
5	"id": "t101",
6	"connectionId": "waon-123",
7	"customerId": "waon-customer-123",
8	"orderId": "order-123",
9	"connectionTransactionId": "waonTx1",
10	"connectionName": "WOAN",
11	"type": "REDEMPTION",
12	"value": 200
13	},
14	{
15	"date": "2023-01-02T12:00:00Z",
16	"id": "t102",
17	"connectionId": "waon-123",
18	"customerId": "waon-customer-123",
19	"orderId": "order-123",
20	"connectionTransactionId": "waonTx1",
21	"connectionName": "WOAN",
22	"type": "REDEMPTION",
23	"value": 200
24	}
25	],
26	"total": 54,
27	"limit": 2,
28	"offset": 0
29	}

Headers

Query parameters

Response

Errors

1	curl https://api.sandbox.primer.io/loyalty-transactions \
2	-H "X-API-KEY: <apiKey>"