Skip to main content

​
GET /v1/products

List products for the organization the API key belongs to.

​
Request

curl "https://merchant-api-prod.anyway.sh/v1/products?page=1&size=20&status=PUBLISHED" \
  -H "X-API-Key: ak_YOUR_API_KEY"

​
Query Parameters

ParamTypeDefaultDescription
pageinteger1Page number
sizeinteger20Page size (max 100)
searchstring—Filter by name substring
statusstringPUBLISHEDLifecycle status: PUBLISHED, DRAFT, or ARCHIVED

​
Response

{
  "success": true,
  "message": "Products retrieved",
  "data": {
    "records": [
      {
        "id": "PRD25XWPQ8TN2VHK6",
        "name": "API Credits — Starter",
        "description": "1,000 API calls",
        "status": "PUBLISHED"
      }
    ],
    "total": 1,
    "page": 1,
    "size": 20,
    "pages": 1
  }
}
description is omitted when unset.

​
GET /v1/products/:id

Get a single product.

​
Request

curl https://merchant-api-prod.anyway.sh/v1/products/PRD25XWPQ8TN2VHK6 \
  -H "X-API-Key: ak_YOUR_API_KEY"

​
Path Parameters

ParamTypeDescription
idstringThe product ID to retrieve

​
Response

{
  "success": true,
  "message": "Product retrieved",
  "data": {
    "id": "PRD25XWPQ8TN2VHK6",
    "name": "API Credits — Starter",
    "description": "1,000 API calls",
    "status": "PUBLISHED"
  }
}
status is one of PUBLISHED, DRAFT, or ARCHIVED.

​
Errors

StatusDescription
401API key missing or invalid.
404Product does not exist or does not belong to your organization.