GET/hyax-api/v1/orders/:id

Get order

Includes `people`, `transactionId`, `trackingNumber`, `shippingCarrier`, `itemsData`.

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

Request examples

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

curl -X GET 'https://platform.hyax.com/hyax-api/v1/orders/clx_example_id' \
  -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",
    "transactionId": null,
    "trackingNumber": null,
    "shippingCarrier": null,
    "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"
  }
}