commerce

GET /v1/orders/{orderId}

Get an order.

Всички крайни точки в commerce

Упълномощаване

Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

Returns one order with its lines and payment summaries. RBAC + RLS scoped.

Параметри

ИмеТипЗадължителноКакво представлява
orderId (path)UuidДаThe order's id.

Отговор

ИмеТипЗадължителноКакво представлява
idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
human_refstringДаHuman-friendly order reference.
statusOrderStatusДаAn order's lifecycle state (docs/31 §4.3).
currencyCurrencyCodeДаISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
subtotal_minorintegerДа
tax_minorintegerДа
discount_minorintegerДа
total_minorintegerДа
billing_countryobjectНе
placed_atobjectНе
created_atstringДа
updated_atstringНе
linesOrderLine[]Да
paymentsPayment[]Да

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 429