cURL
Products
Get all Products
Returns all products from the system that the user has access to
GET
cURL
Get all Products
Retrieve a comprehensive list of products available across all affiliate brands. This endpoint provides detailed product information including pricing, availability, images, and specifications.HTTP Request
Query Parameters
integer
Page number for pagination. Starts at 1. Default: 1 Example: 2
integer
Number of products per page. Minimum 1, maximum 100. Values outside this range return
400. Default: 5 Example: 25
Example: 25boolean
Filter products by availability status. Example: true
string
Search term to filter products by name or description. Example:
“smartphone”
string
Price range filter in cents. Format:
from:to Format: {minPrice}: {maxPrice} (in cents) Example: “7400:8000” (R 80,00)string
Filter products by specific brand organization IDs. Multiple IDs separated by
commas. Format: UUID separated by commas Example:
“e36f5bbb-3e5f-42e2-be4c-6c32dac101c2,12345678-1234-1234-1234-123456789012”
Example Requests
Basic Request
With Pagination
With Search and Price Filter
Filter by Specific Brands
Response Format
array
Array of product objects
integer
Total number of products matching the filters. Use
page and limit query
parameters to paginate; the response does not echo current page metadata.Product Object Structure
string
Brand organization UUID
string
Product identifier
boolean
Product availability status
string
Product creation timestamp (ISO 8601)
string
Last update timestamp (ISO 8601)
string
Product name/title
string
Product description (HTML format)
string
Product page URL
array
Product images
array
Product variants/options
array
Additional product data
Example Response
Error Responses
400 Bad Request
401 Unauthorized
500 Internal Server Error
Usage Examples
JavaScript/Node.js
Python
PHP
Best Practices
- Pagination: Always implement pagination for large datasets
- Caching: Cache product data when appropriate (TTL: 60 seconds)
- Search Optimization: Use specific search terms for better results
- Price Filtering: Use price ranges to narrow down products
- Error Handling: Implement proper error handling for all responses
- Rate Limiting: Respect the 60 requests per 60 seconds limit
Common Use Cases
- Product Catalog: Display available products with filtering
- Price Comparison: Compare prices across different brands
- Inventory Management: Check product availability and stock levels
- Search Integration: Implement product search functionality
- Recommendation Engine: Build product recommendation systems
Authorizations
Query Parameters
Page number for pagination. Starts at 1.
Number of products per page. Maximum 100. Default: 5.
Required range:
x <= 100Search term to filter products by name or description.
Price range filter in cents. Format: from:to
Pattern:
^[0-9]+:[0-9]+$Filter products by specific brand organization IDs. Multiple IDs separated by commas.
Filter products by availability status