Skip to content

docs: clarify loyalty point transaction history endpoints #1291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify loyalty point transaction history endpoints #1291

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions documentation/build/loyalty-points.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,21 @@ When you transfer points from one card to another, the expiration date is reset

However, you can't transfer expired or pending points.

### Loyalty point transaction history

You can retrieve the full point transaction history for a customer's loyalty card using the Loyalties API. The response includes all point movements such as `POINTS_ACCRUAL`, `POINTS_REDEMPTION`, `POINTS_REFUND`, `POINTS_ADDITION`, `POINTS_REMOVAL`, `POINTS_EXPIRATION`, and `POINTS_TRANSFER`.

| Endpoint | Use when |
|---|---|
| [`GET /v1/loyalties/members/{memberId}/transactions`](/api-reference/loyalties/list-loyalty-card-transactions) | You want all point movements for a specific loyalty card without filtering by campaign. `memberId` is the loyalty card code. |
| [`GET /v1/loyalties/{campaignId}/members/{memberId}/transactions`](/api-reference/loyalties/list-loyalty-card-transactions-with-campaign-id) | You want point movements scoped to a specific loyalty campaign. |

A customer can hold loyalty cards in more than one loyalty campaign. The `loyalty_cards` array on the customer object lists every card code the customer holds, so call the endpoint above once per `memberId` to compile the customer's full points history across programs.

<Info>
The [List Voucher Transactions](/api-reference/vouchers/list-voucher-transactions) endpoint (`GET /v1/vouchers/{code}/transactions`) is a generic, voucher-centric endpoint that returns credit movements for any gift card or loyalty card by code. For points history specifically, the Loyalties endpoints above are recommended because they return point-specific transaction types and support advanced `filters`.
</Info>

## Pending points

Pending points are points that have been earned by a customer, but are not yet available for redemption. This status is used to create a mandatory waiting period for points to ensure validity, account for potential returns, or synchronize with external systems.
Expand Down
Loading