Loyalty API

List the transactions for a customer

GET
https://api.sandbox.primer.io/loyalty-transactions

The Loyalty API is currently in beta. Please contact support@primer.io for access.

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

connectionId
optional string

Filter transactions by customer Id.

customerId
optional string

Filter transactions by customer Id.

orderId
optional string

Filter transactions by orderId.

limit
optional integer

Limit the number of returned results

offset
optional integer

The number of items to skip before returning results

Response

This endpoint return an object.
items
optional list of objects

The list of loyalty transactions

total
optional integer

The total number of available results

limit
optional integer

The limit of the paged result

offset
optional integer

The offset of the paged result

Errors

GET
/loyalty-transactions
1
2
curl "https://api.sandbox.primer.io/loyalty-transactions" \
     -H "X-API-KEY: <apiKey>"
Response
1
2
3
4
5
6
7
{
  "items": [
    {
      "type": "REDEMPTION"
    }
  ]
}