Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/orders/{orderId} \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Returns one order with its lines and payment summaries. RBAC + RLS scoped.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
orderId (path) | Uuid | Yes | The order's id. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
human_ref | string | Yes | Human-friendly order reference. |
status | OrderStatus | Yes | An order's lifecycle state (docs/31 §4.3). |
currency | CurrencyCode | Yes | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
subtotal_minor | integer | Yes | — |
tax_minor | integer | Yes | — |
discount_minor | integer | Yes | — |
total_minor | integer | Yes | — |
billing_country | object | No | — |
placed_at | object | No | — |
created_at | string | Yes | — |
updated_at | string | No | — |
lines | OrderLine[] | Yes | — |
payments | Payment[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429