GET/hyax-api/v1/orders

List orders

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Query parameters

Name	Required	Description
limit	No	Default 25, max 100
offset	No	Default 0
status	No	`PENDING` \| `PAID` \| `FAILED` \| `REFUNDED` (payment status)

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X GET 'https://platform.hyax.com/hyax-api/v1/orders?limit=10&offset=0' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": [
    {
      "id": "clx…",
      "orderNumber": "ORD-abc12345",
      "paymentPlatform": "MANUAL",
      "paymentStatus": "PAID",
      "fulfillmentStatus": "UNFULFILLED",
      "amount": 49.99,
      "currency": "USD",
      "paymentDate": "2025-01-15T12:00:00.000Z",
      "itemsData": null,
      "itemCount": 0,
      "notes": null,
      "isTest": false,
      "peopleId": "clx…",
      "people": { "id": "clx…", "email": "[email protected]", "name": null },
      "createdAt": "2025-01-15T12:00:00.000Z",
      "updatedAt": "2025-01-15T12:00:00.000Z"
    }
  ],
  "pagination": { "total": 1, "limit": 25, "offset": 0, "hasMore": false }
}