Loyalty Phase B Planned
Loyalty lets merchants reward repeat customers - earning points on purchases, climbing membership tiers, and redeeming rewards. Point earning on completed orders is live today; the broader program management surface is planned for Phase B.
1. Identity
| Property | Value |
|---|---|
| Module ID | EXT-01 |
| Tier | Extended |
| Status | Planned |
| Phase | P1-P3 |
| Priority | MEDIUM |
| Primary users | Owner / Manager / Customer |
2. Purpose & Scope
| Included | Excluded |
|---|---|
| Earn points on completed sale orders | Cross-merchant / shared point pools |
| Membership tiers (Bronze → Gold) | Paid membership billing |
| Rewards catalog & redemption | Gift-card issuance (separate module) |
| Referral & birthday rewards | Marketing message delivery (see Marketing) |
3. Capabilities
| Capability | What the user can do |
|---|---|
| Points earning | Auto-award points when an order completes payment |
| Points redemption | Spend points for discounts or rewards |
| Membership tiers | Define status levels with benefits |
| Rewards catalog | Configure redeemable rewards |
| Referral program | Reward customers for referrals |
| Birthday rewards | Auto-grant rewards on birthdays |
| Program analytics | Track member activity & program ROI |
Today only points earning is wired in code (award on order completion, idempotent per order). Everything else is roadmap.
4. Module Dependencies
| Depends on | Why |
|---|---|
| Customer | Customer identity holds the point balance and tier |
| Orders | Completed orders are the earning trigger |
5. Backend Packages
Implementation detail lives in the developer docs - this section only maps the module to the services that power it.
| Package | Role | Developer docs |
|---|---|---|
@nx/sale | Awards points on order payment success (idempotent) | Customer Points |
@nx/identity | Stores customer point balance | Identity |
Engineering Mapping (Feature ⇄ Package)
The horizontal axis of the Feature Spine - each business feature (
<AREA>in the URD) maps to its engineering home. Reciprocal: the package docs link back here.
| Feature | Dev package | Status |
|---|---|---|
PTS Points Earning | @nx/sale | Built |
RDM Redemption & Tiers | @nx/sale | Planned |
6. Key User Flows
7. Roles & Permissions
| Role | Can | Cannot |
|---|---|---|
| Owner | Configure earning rate, tiers, rewards (planned) | - |
| Manager | View member activity & balances | Change global earning rate |
| Customer | Earn & view points | Adjust own balance manually |
8. Status & Roadmap
| Phase | Capabilities |
|---|---|
| P1 | Points earning on order completion (live) |
| P2 | Redemption, membership tiers, rewards catalog |
| P3 | Referral, birthday rewards, program analytics |