API
Fetch order
Retrieve a Yuzu order by order ID or order key.
Retrieve an order when you need its current status, order keys, document IDs, or routing details before printing or downloading PDFs.
GET https://app.yuzu.so/api/orders/{orderIdOrKey}
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. |
Order keys can contain /, :, and other path-sensitive characters. If you fetch by order key, URL-encode the complete key before adding it to the URL path.
Query parameters
| Parameter | Type | Description |
|---|---|---|
includeRaw | boolean | Optional. Set to true to include raw source payload data where available. |
Example
Fetch by Yuzu order ID:
curl 'https://app.yuzu.so/api/orders/a2cb2c3d-4e5f-6g7h-8i9j-123a45c67890' \
--header 'X-API-Key: YOUR_API_KEY'
Fetch by order key:
curl 'https://app.yuzu.so/api/orders/org_exampleTeam123456789%2Fwarehouse-east-WE-1001' \
--header 'X-API-Key: YOUR_API_KEY'
Response
Successful requests return the order object.
{
"id": "a2cb2c3d-4e5f-6g7h-8i9j-123a45c67890",
"order_keys": [
"org_exampleTeam123456789/warehouse-east-WE-1001"
],
"order_number": "#1001",
"status": "ready",
"customer_data": {
"firstName": "Jill",
"lastName": "Blogs",
"email": "jill@blogs.com"
},
"shipping_address": {
"firstName": "Jill",
"lastName": "Blogs",
"address1": "123 Joe Road",
"city": "Joesville",
"state": "DE",
"postalCode": "12345",
"country": "US"
},
"documents": [
{
"id": "document_id_here",
"tag": "default",
"sequence": 1,
"template_id": "template_id_here",
"printer_id": "printer_id_here"
}
]
}
Use documents[].id with Fetch order PDF when you need to download a specific document from a multi-document order.
Common status codes:
| Status | Meaning |
|---|---|
200 | Order returned. |
400 | Invalid query parameter. |
401 | Missing, malformed, or invalid API key. |
404 | No matching order was found. |
5xx | Temporary service issue. Retry with backoff. |