Querying
List endpoints use query parameters for cursor pagination and filtering. Parameters should be URL encoded.
Pagination
The order, customer, reward, card, and voucher collections accept:
| Parameter | Default | Description |
|---|---|---|
cursor | None | Opaque cursor returned by the previous response. |
limit | 25 | Number of results, from 1 to 100. Voucher lists default to 10. |
Start without a cursor. If pagination.hasMore is true, pass pagination.nextCursor unchanged to retrieve the next set:
GET /v1/public/customers?limit=25
GET /v1/public/customers?limit=25&cursor=RETURNED_CURSOR
Do not construct, decode, store permanently, or modify cursors. Keep the same filters and ordering while walking a collection. A malformed cursor returns 400.
For backwards compatibility, the voucher list also accepts page. New integrations should use cursor; do not combine page and cursor.
Voucher filters
status:pending,active,expired,redeemed,cancelled, orpartial.search: Case-insensitive search across issued voucher codes and titles.
GET /v1/public/vouchers?status=active&search=gift&limit=25
Other filters
- Orders: exact
orderNumberandcustomerId. - Customers: exact
emailor case-insensitivesearchacross names and email addresses. - Rewards:
status(active,redeemed, orexpired) andcustomerId. - Cards:
active(trueorfalse).
Filters are combined. Resources are returned newest first, with stable ordering for resources that share a timestamp.