API
Fetch order PDF
Download the rendered PDF for a Yuzu order.
Fetch order PDF
Download the rendered PDF for an order so your WMS, OMS, or print pipeline can send it to an existing printer queue.
GET https://app.yuzu.so/api/orders/{orderIdOrKey}/pdf
Headers
X-API-Key: YOUR_API_KEY
Accept: application/pdf
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 are built as {source}-{sourceId}. For app-ingested orders, such as Shopify orders, source is the installed app ID, not the app type or slug. See Order keys.
Query parameters
| Parameter | Type | Description |
|---|---|---|
documentId | string | Optional. Fetch a specific order document PDF. |
all | boolean | Optional. Set to true or 1 to merge all downloadable documents for the order into one PDF. |
Example
Fetch by Yuzu order ID:
curl 'https://app.yuzu.so/api/orders/a2cb2c3d-4e5f-6g7h-8i9j-123a45c67890/pdf' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'Accept: application/pdf' \
--output order.pdf
Fetch by app-ingested order key:
curl 'https://app.yuzu.so/api/orders/a2cb2c3d-4e5f-6g7h-8i9j-0k1l2m3n4o5p-1234567890/pdf' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'Accept: application/pdf' \
--output order.pdf
Fetch and merge all downloadable documents for an order:
curl 'https://app.yuzu.so/api/orders/a2cb2c3d-4e5f-6g7h-8i9j-123a45c67890/pdf?all=true' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'Accept: application/pdf' \
--output order.pdf
Response
Successful requests return the PDF bytes directly.
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: inline; filename="order-a2cb2c3d-4e5f-6g7h-8i9j-123a45c67890.pdf"
Common status codes:
| Status | Meaning |
|---|---|
200 | PDF returned as application/pdf. |
400 | Invalid query parameter. |
401 | Missing, malformed, or invalid API key. |
404 | No matching order or downloadable document was found. |
502 | The order exists, but Yuzu could not fetch the rendered PDF from the render service. Retry once, then contact support if it persists. |
5xx | Temporary service issue, or the order key could not be resolved. Verify the order ID or key and retry with backoff. |