Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.
Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
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.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
orderId (path) | Uuid | Иә | The order's id. |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
id | Uuid | Иә | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Иә | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
human_ref | string | Иә | Human-friendly order reference. |
status | OrderStatus | Иә | An order's lifecycle state (docs/31 §4.3). |
currency | CurrencyCode | Иә | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
subtotal_minor | integer | Иә | — |
tax_minor | integer | Иә | — |
discount_minor | integer | Иә | — |
total_minor | integer | Иә | — |
billing_country | object | Жоқ | — |
placed_at | object | Жоқ | — |
created_at | string | Иә | — |
updated_at | string | Жоқ | — |
lines | OrderLine[] | Иә | — |
payments | Payment[] | Иә | — |
Бұл соңғы нүкте қайтара алатын қателер
401 · 403 · 404 · 429