​

Partner API Endpoints

​

Base URL

• Staging: https://staging-api.loyalty.lt/{locale}/partners/
• Production: https://api.loyalty.lt/{locale}/partners/

​

Partner Management

​

Core Partner Operations

• GET /{locale}/partners/{id} - Get partner details and configuration
• Partner profile information, settings, and capabilities
• Integration status and API limits
• Business verification and compliance status

​

Customer Management for Partners

• GET /{locale}/partners/customers - List customers associated with partner
• Customer segmentation and analytics
• Partner-specific customer interactions
• Cross-store customer tracking

​

Transaction Management

• GET /{locale}/partners/transactions - Partner transaction history
• Multi-store transaction aggregation
• Revenue and commission tracking
• Transaction categorization and filtering

​

Games & Engagement

• GET /{locale}/partners/games - Partner-specific games
• POST /{locale}/partners/games - Create new games
• PUT /{locale}/partners/games/{id} - Update game settings
• Game performance analytics
• Custom game configurations
• Coupon generation settings (multiple coupons, validity periods)
• Partner branding and themes

​

Partner Cards Management

• GET /{locale}/partners/cards - List partner loyalty cards
• POST /{locale}/partners/cards - Create new loyalty card
• GET /{locale}/partners/cards/{id} - Get card details
• PUT /{locale}/partners/cards/{id} - Update card configuration
• DELETE /{locale}/partners/cards/{id} - Delete loyalty card
• Custom point systems and redemption rules
• Coupon validity settings - Configure default coupon expiration periods
• Card design customization and branding
• Multi-shop card assignment

​

Admin Partner Management

​

Partner Statistics & Analytics

• GET /{locale}/admin/partners/stats - System-wide partner statistics
• Partner performance metrics
• Revenue and growth analytics
• Partner tier and status reporting

​

Commission Management

• GET /{locale}/admin/partners/{id}/commission/rates - Commission rate configuration
• POST /{locale}/admin/partners/{id}/commission/force-sync - Force commission sync
• POST /{locale}/admin/partners/{id}/commission/lock - Lock commission period
• GET /{locale}/admin/partners/{id}/commission/lock-status - Check lock status
• POST /{locale}/admin/partners/{id}/commission/unlock - Unlock commission period

​

Communication Management

• GET /{locale}/admin/partners/{id}/messages - Partner message history
• POST /{locale}/admin/partners/{id}/send-email - Send email to partner
• GET /{locale}/admin/partners/{id}/messages/{messageId}/attachment/{attachmentId} - Download message attachments

​

SMS Account Management

• GET /{locale}/admin/partners/{id}/sms-accounts - SMS account settings
• SMS provider configuration
• Message template management
• SMS usage analytics

​

Authentication Methods

​

Partner Authentication

# Partner authentication
curl -X POST "https://staging-api.loyalty.lt/en/partners/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "partner@example.com",
    "password": "secure_password"
  }'

​

Admin Authentication

# Admin authentication for partner management
curl -X GET "https://staging-api.loyalty.lt/en/admin/partners/stats" \
  -H "Authorization: Bearer admin_jwt_token"

​

Key Features

​

Multi-Store Operations

• Centralized Management: Manage multiple store locations from one dashboard
• Unified Analytics: Aggregated reporting across all locations
• Staff Management: Role-based access for different store staff
• Inventory Sync: Coordinated loyalty campaigns across stores

​

Advanced Analytics

• Revenue Analytics: Detailed revenue attribution and tracking
• Customer Insights: Advanced customer behavior analytics
• Performance Metrics: KPI tracking and benchmarking
• Predictive Analytics: Customer lifetime value and churn prediction

​

White-Label Solutions

• Custom Branding: Partner-specific branding and themes
• Custom Domains: White-label partner portals
• API Customization: Partner-specific API configurations
• Integration Support: Dedicated integration assistance

​

Enterprise Features

• Commission Management: Automated commission calculation and payments
• Compliance Reporting: Regulatory compliance and reporting tools
• Audit Trails: Complete activity logging and auditing
• Data Export: Comprehensive data export capabilities

​

Common Use Cases

​

Multi-Store Chain Management

# Get all partner locations and performance
GET /{locale}/partners/{partnerId}

# View aggregated customer base
GET /{locale}/partners/customers?store_location=all

# Analyze transaction patterns across stores
GET /{locale}/partners/transactions?date_range=last_30_days&group_by=store

​

Franchise Operations

# View franchise-specific analytics
GET /{locale}/admin/partners/{franchiseId}/commission/rates

# Send communication to franchise owners
POST /{locale}/admin/partners/{franchiseId}/send-email

# Monitor franchise performance
GET /{locale}/admin/partners/stats?filter=franchise_network

​

White-Label Partner Portal

# Configure partner-specific branding
PUT /{locale}/partners/{partnerId}/branding

# Set up custom games and campaigns
GET /{locale}/partners/games?customizable=true

# Export client data for reporting
POST /{locale}/partners/transactions/export?format=csv

​

Error Handling

​

Rate Limits

​

Data Export & Import

​

Export Capabilities

• Customer Data: Complete customer profiles and preferences
• Transaction History: Detailed transaction records with metadata
• Analytics Reports: Pre-built business intelligence reports
• Commission Reports: Detailed commission calculations and payments

​

Import Capabilities

• Customer Migration: Bulk customer import from existing systems
• Transaction History: Historical transaction data import
• Product Catalogs: Bulk product and offer imports
• Staff Data: Employee and permission imports

​

Next Steps