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, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі 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[]Так

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 429