API
Fetch order status
Retrieve the current status for a Yuzu order.
Fetch a lightweight status response for an order. Use this when your WMS, OMS, or fulfilment process needs to poll whether an order is ready or printed without retrieving the full order object.
GET https://app.yuzu.so/api/orders/{orderIdOrKey}/status
Headers
X-API-Key: YOUR_API_KEY
Path parameters
| Parameter | Type | Description |
|---|---|---|
orderIdOrKey | string | Yuzu order UUID or valid order key. URL-encode order keys when using them in the path. |
Example
curl 'https://app.yuzu.so/api/orders/a2cb2c3d-4e5f-6g7h-8i9j-123a45c67890/status' \
--header 'X-API-Key: YOUR_API_KEY'
Response
{
"id": "a2cb2c3d-4e5f-6g7h-8i9j-123a45c67890",
"order_keys": [
"org_exampleTeam123456789/warehouse-east-WE-1001"
],
"status": "ready",
"created_at": "2026-05-19T12:00:01.000Z",
"updated_at": "2026-05-19T12:00:01.000Z"
}
Statuses:
| Status | Meaning |
|---|---|
ready | The order is ready for printing or downstream processing. |
printed | The order has been printed. |
ignored | The order is intentionally excluded from printing. |
Common status codes:
| Status | Meaning |
|---|---|
200 | Status returned. |
401 | Missing, malformed, or invalid API key. |
404 | No matching order was found. |
5xx | Temporary service issue. Retry with backoff. |