Get orders

GET

/orders

GET

/orders

$ curl https://public-api.alphax.com/orders \
>      -H "X-API-Key: <apiKey>"

200Retrieved

1 {
2   "orders": [
3     {
4       "id": "01jc0tpy0zjb0pvfh2jcej8yd6",
5       "reference": "ORDER-12345",
6       "description": "Payment for Order #12345",
7       "currency": "USD",
8       "paidNotificationUrl": "https://your-backend-app.com/payment-notification/ORDER-12345",
9       "dueNotificationUrl": "string",
10       "paymentLink": "https://pay.demo.alphax.asia/01k5dcgey2my8jptnmfpdft0xx",
11       "dueAt": "2026-05-05T22:00:00.00Z",
12       "paidAt": "2026-05-05T22:00:00.00Z",
13       "createdAt": "2026-05-05T22:00:00.00Z",
14       "updatedAt": "2026-05-05T22:00:00.00Z",
15       "lineItems": [
16         {
17           "id": "01k5dcgey2my8jptnmfpdft023",
18           "name": "T-Shirt",
19           "quantity": 2,
20           "unitPrice": 10.99
21         }
22       ]
23     }
24   ],
25   "page": 1,
26   "limit": 10
27 }

Authentication

X-API-Keystring

API Key authentication via header

Query parameters

pageintegerOptional

The current page (default 1)

limitintegerOptional

Items per page (default 10, max 99)

Response

Get orders successfully

orderslist of objectsOptional

pageintegerOptional

limitintegerOptional