partner
GET /v1/partner/customers/{externalId}/domain-orders/{orderId}
Read one of your customer's domain orders, and each domain it became.
Authentication
Send an API key as a bearer token. The key must carry the partner.domains permission; a key without it is refused with 403, not 404.
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/partner/customers/{externalId}/domain-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
The authoritative state of an order you placed — its status, and for every line the domain's own status, nameservers and expiry once provisioning has created it (domain is null until then). An order of another customer, of another partner, or one the customer placed themselves is a 404. There is no pay_url here: the link is shown once, when the order is placed. Requires partner.domains.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
externalId (path) | string | Yes | YOUR id for that customer — whatever your own system calls them. It is what makes linking idempotent, and it is scoped to your partner programme: another partner's id is a 404… |
orderId (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
order_id | string | Yes | — |
human_ref | string | Yes | The reference the payment page returns to you as ?order=. |
pay_url | string | No | Only in the response that placed (or replayed) the order: the hosted page the customer pays on. It carries a secret that is stored nowhere — treat it as one. |
pay_expires_at | string | No | — |
org_id | string | Yes | — |
status | string | Yes | pending_payment for a freshly placed order; afterwards the order's lifecycle (paid, fulfilling, completed, partially_fulfilled, canceled, …). |
currency | string | Yes | — |
subtotal_minor | integer | Yes | — |
tax_minor | integer | Yes | — |
total_minor | integer | Yes | — |
lines | PartnerOrderLine[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 429