Skip to content

Issue Loyalty Points

POST /loyalty/accounts/{id}/points command bearer

Issues loyalty points to a member's account based on a closed order. Requires active loyalty membership.


Overview

ID issue-points-api
Method POST
Path /loyalty/accounts/{id}/points
Classification command
Domain loyalty
Capability loyalty
Service issue-points
Application crm — CRM
Auth bearer

Request Body

Business Object order
Description Confirmed commercial commitment created from checkout or assisted selling.
Classification aggregate-root
Lifecycle draft → confirmed → in-fulfilment → partially-fulfilled → completed → return-in-progress → cancelled

Response

Business Object loyalty-account
Description Account used to track loyalty participation state, balances, benefits, and point activity.

Events Emitted

Event Classification Object Description
loyalty-points-issued transitioned loyalty-account Calculated loyalty points were credited to a customer's loyalty account.
points-issued updated loyalty-account Loyalty points have been issued to a member's account based on a qualifying purchase.

Scenarios using loyalty

Scenario Description
Clienteling Sale A store associate uses a clienteling application to identify a known customer, review their purchase
Customer Registration A new customer creates a unified identity that can be recognised consistently across digital and phy
Loyalty Enrollment A customer is enrolled into the retailer's loyalty programme during or after a transaction — in-stor
Loyalty Tier Upgrade A customer's loyalty standing is reviewed after new qualifying activity and may be promoted to a hig
Scan and Go Customer scans items using a mobile app while shopping, receives promotions and loyalty benefits in
API Method Path Type
Enroll Loyalty Member POST /loyalty/members command
Redeem Loyalty Points POST /loyalty/accounts/{id}/redemptions command
Earn Points POST /members/{id}/earn command
Redeem Points POST /members/{id}/redeem command
Get Member Balance GET /members/{id}/balance query