Introduction

This guide outlines the loyalty card management API endpoints in the system. These endpoints allow users to create, retrieve, update, and delete loyalty cards, as well as query loyalty points and integrate with external loyalty programs.

The Loyalty Card API provides functionality for:

1. Loyalty Card Management

• Create loyalty cards for authenticated users

• Retrieve loyalty card details and available points

• Update loyalty card information

• Delete/deactivate loyalty cards

• Search for existing loyalty accounts in external systems

2. Registration Methods

• Standard registration with SMS verification (OTP)

• Registration without SMS verification (for pre-verified users)

• Search and link existing external loyalty accounts

• Automatic account creation if not found in external system

3. Points Integration

• Query available loyalty points from external systems

• Cache loyalty points for performance (2-minute cache)

• Use loyalty points during checkout process

• Track point transactions and redemptions

4. External System Integration

• Synchronize user data with external loyalty providers

• Configurable SMS gateway for verification codes

• Automatic account linking and creation

Each endpoint is designed to support loyalty program operations where authenticated users can manage their loyalty cards and redeem points for discounts during checkout.

NOTE: All methods require authentication via session cookies. The loyalty card system integrates with external loyalty providers and requires proper configuration of the CUSTOMER_LOYALTY_CARD_SERVICE setting.