Loyalty Program API Overview

​

Features

• Points-Based Rewards: Customers earn points based on purchase amounts
• Tiered Membership: Bronze, Silver, Gold, Platinum tiers with multipliers
• Redeemable Rewards: Create rewards that customers can redeem for discounts
• Customer Management: Track customer profiles, points balance, and transaction history
• Program Configuration: Flexible points earning and redemption rates

​

Authentication

• loyalty:read - View loyalty data
• loyalty:create - Create and manage programs, rewards, and redemptions
• customers:read - View customer data
• customers:create - Create customers
• customers:delete - Delete customers

​

Base URL

https://api.restai.app/v1/loyalty

​

Core Concepts

​

Loyalty Programs

• Points per currency unit: How many points earned per dollar spent
• Currency per point: How much each point is worth when redeemed
• Active status: Whether the program is currently active

​

Tiers

• Bronze (0+ points): 100% point multiplier
• Silver (500+ points): 110% point multiplier
• Plata (2000+ points): 125% point multiplier
• Platino (5000+ points): 150% point multiplier

​

Rewards

• Points cost: How many points required
• Discount type: Percentage or fixed amount
• Discount value: Amount of discount applied

​

Customers

• Contact information (name, email, phone)
• Points balance
• Total points earned (for tier calculation)
• Current tier
• Transaction history

​

Quick Start

1. Create a loyalty program with earning/redemption rates
2. Configure rewards that customers can redeem
3. Add customers as they make purchases
4. Award points automatically based on order totals
5. Redeem rewards when customers want to use points

​

Next Steps

• Loyalty Program Management - Set up programs and rewards
• Customer Management - Manage customer profiles and points