Skip to main content
GET
/
api
/
canary
/
products
Retrieves all products in the merchant’s catalog.

​
Query Parameters

​
active
boolean
Filter by active status (true or false)
​
offset
number
Number of products to skip (default: 0)
​
limit
number
Maximum number of products to return (default: 50)

​
Response

​
Success
​
data
array
Array of products
​
pagination
object
Pagination information

​
Example Response

{
  "data": [
    {
      "id": "product_001",
      "merchantId": "merchant_456",
      "name": "Airtime",
      "description": "Mobile phone airtime",
      "amount": 5000,
      "currency": "ZAR",
      "active": true,
      "metadata": {
        "category": "telecom"
      },
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-15T10:30:00.000Z"
    },
    {
      "id": "product_002",
      "merchantId": "merchant_456",
      "name": "Data Bundle",
      "description": "1GB data bundle",
      "amount": 10000,
      "currency": "ZAR",
      "active": true,
      "metadata": {
        "category": "telecom",
        "size": "1GB"
      },
      "createdAt": "2025-01-14T09:20:00.000Z",
      "updatedAt": "2025-01-14T09:20:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 25,
    "hasMore": false
  }
}

​
Error Responses

​
Unauthorized
Invalid or missing authentication token
​
Internal Server Error
An unexpected error occurred on the server

​
Authentication

This endpoint requires Bearer token authentication.