Clients
Looking up the commerce's members, their points and the benefits they can buy or already bought.
A client is a person who joined the commerce's club. They have their own
client_code, point balance and history.
Client and member
The API resource is client, and that is the name used for fields and paths. In
prose this documentation says "member", which is the product's term for the people
in the club.
This section is read-only: it exists to show a member's state inside your system, on the point-of-sale screen, in the online store's profile page, in a CRM. Points move by recording consumptions and redeeming benefits, not from here.
The two benefit lists
There are two per-member benefit endpoints, and it is worth not mixing them up:
| Endpoint | What it returns |
|---|---|
/available-benefits | The ones the member can buy with the points they hold |
/benefits | The ones they already bought and can still redeem, each with its code |
List clients
The commerce's full list, paginated.
Get a client
One client by their code, with their point balance.
Benefits they can buy
The part of the catalog their points cover.
Purchased benefits
The ones already bought, each with its redemption code.
Credential
The whole section goes from your server, with the commerce API key:
Authorization: Bearer {api-key}It returns data about all your members
These endpoints expose the name, email and points of the people in the club. Do not call them from the frontend: if you need the user themselves to see their own data, that is what My account is for, and it only shows their own.