Introduction

Lomadee API Documentation

Welcome to Lomadee API

The Lomadee API enables seamless integration and programmatic management of your affiliate campaigns, brands, and orders. Our RESTful API provides comprehensive endpoints to handle all aspects of your affiliate network operations.

Available Resources

Brands

• List and retrieve all available brands
• Get detailed information about specific brands
• Manage affiliate channels and brand relationships
• Monitor approval status and access restrictions
• Track brand performance metrics

Campaigns

• List and filter active campaigns
• Campaign types:
  • PersonalCoupon: Unique coupon codes for specific users
  • GenericCoupon: Public coupon codes for general use
  • Offer: Special promotional offers and deals
• Manage campaign lifecycle:
  • Set validity periods
  • Control campaign highlights
  • Update status
  • Organize by categories and tags

Orders

• Query and track completed orders
• Monitor commission status and earnings
• View detailed item information
• Track transaction values and commission rates
• Export order reports

Authentication

All API requests require authentication using an API key in the request header:

{
  "headers": {
    "x-api-key": "your-api-key"
  }
}

Pagination

List endpoints support pagination with the following parameters:

• page: Current page number (starts at 1)
• limit: Number of items per page (default: 10, max: 100)

Example response with pagination:

{
  "data": {
    // Resource specific data
  },
  "meta": {
    "total": 100,
    "page": 1,
    "limit": 10,
    "totalPages": 10
  }
}

Status Codes

• 200: Success - Request completed successfully
• 400: Bad Request - Invalid parameters or malformed request
• 401: Unauthorized - Missing or invalid API key
• 403: Forbidden - Insufficient permissions
• 404: Not Found - Resource doesn’t exist
• 500: Internal Server Error - Server-side error

API Limits and Quotas

• Rate limiting: 10 requests per minute
• Maximum payload size: 1MB per request
• Request timeout: 60 seconds
• Response cache TTL: 60 seconds
• Concurrent connections: 5 per API key

Best Practices

1. Implement proper error handling
2. Use pagination for large datasets
3. Cache responses when appropriate
4. Monitor rate limits
5. Validate request parameters

Support and Resources

For technical assistance and API-related questions:

1. Comprehensive API Documentation
2. Technical Support Portal
3. Developer Portal with:
   • API Reference
   • Code Examples
   • SDK Downloads
   • Integration Guides