partner

GET `/v1/partner/customers/{externalId}/hosting-orders/{orderId}`

Read one of your customer's hosting orders, and the site it became.

Аутентификација

Пошаљите API кључ као bearer токен. Кључ мора имати дозволу partner.domains; кључ без ње се одбија уз 403, а не 404.

Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

curl -X GET https://api.zinndigital.com/v1/partner/customers/{externalId}/hosting-orders/{orderId} \
  -H "Authorization: Bearer zdk_live_…"

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли

Детаљи

The authoritative state of a hosting order you placed: its status, the subscription the paid plan became (subscription_id, null until fulfilment), and — when the order carried a site — the site's id and status once fulfilment has created it, or error with the reason it could not be. A trial order also carries trial: its status, its ends_at and cutoff_at, and the plan to subscribe to. A domain order, another customer's or another partner's order is a 404. There is no pay_url here. Requires partner.domains.

Параметри

Назив	Тип	Обавезно	Шта је ово
`externalId (path)`	`string`	Да	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`	Да	—

Одговор

Назив	Тип	Обавезно	Шта је ово
`order_id`	`string`	Да	—
`human_ref`	`string`	Да	The reference the payment page returns to you as `?order=`.
`pay_url`	`string`	Не	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. Absent on a trial…
`pay_expires_at`	`string`	Не	—
`org_id`	`string`	Да	—
`trial`	`PartnerHostingTrial \| null`	Да	Present on an order placed with `trial: true`; `null` on every other order. Until fulfilment starts the trial, `status` is `pending` and the dates are `null`.
`replaces_subscription_id`	`object`	Не	The live plan subscription this order replaces, as named on the request (ADR 0036); `null` when the order ADDS a plan. Once fulfilled that subscription is `canceled` and…
`status`	`string`	Да	As on `PartnerOrder`.
`currency`	`string`	Да	—
`term_months`	`integer`	Да	—
`subtotal_minor`	`integer`	Да	—
`tax_minor`	`integer`	Да	—
`total_minor`	`integer`	Да	—
`lines`	`PartnerHostingOrderLine[]`	Да	—
`site`	`PartnerHostingOrderSite \| null`	Да	—
`subscription_id`	`object`	Да	The subscription the paid plan line became; `null` until fulfilment.

Грешке које ова крајња тачка може вратити

401 · 403 · 404 · 429

GET /v1/partner/customers/{externalId}/hosting-orders/{orderId}