Loyalty APIs for Developers

// Create a new member
POST /v1/members
{
  "email": "john@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1234567890",
  "birthDate": "1990-01-15",
  "preferences": {
    "emailNotifications": true,
    "smsNotifications": false
  }
}

// Get member details
GET /v1/members/{memberId}

// Update member profile
PUT /v1/members/{memberId}
{
  "firstName": "John",
  "lastName": "Smith",
  "preferences": {
    "emailNotifications": false
  }
}

// Award points for purchase
POST /v1/transactions
{
  "memberId": "mem_123",
  "type": "earn",
  "points": 150,
  "amount": 75.00,
  "description": "Purchase at Store #1",
  "metadata": {
    "orderId": "order_456",
    "items": ["item1", "item2"]
  }
}

// Redeem points
POST /v1/transactions
{
  "memberId": "mem_123",
  "type": "redeem",
  "points": -100,
  "rewardId": "reward_789",
  "description": "$10 discount applied"
}

// Get available rewards
GET /v1/rewards?memberId=mem_123

// Create custom reward
POST /v1/rewards
{
  "name": "$5 Off Next Purchase",
  "description": "Save $5 on any purchase over $25",
  "pointsCost": 50,
  "rewardType": "discount",
  "value": 5.00,
  "expirationDays": 30,
  "minPurchaseAmount": 25.00
}

// Redeem a reward
POST /v1/rewards/{rewardId}/redeem
{
  "memberId": "mem_123"
}

// Get program analytics
GET /v1/analytics/overview
{
  "dateRange": {
    "start": "2024-01-01",
    "end": "2024-12-31"
  }
}

// Member activity report
GET /v1/analytics/members
{
  "groupBy": "tier",
  "metrics": ["totalSpend", "pointsEarned", "visits"]
}

// Points activity
GET /v1/analytics/points
{
  "period": "monthly",
  "breakdown": ["earned", "redeemed", "expired"]
}