commerce

GET /v1/orders/{orderId}

Get an order.

Gbogbo àwọn commerce endpoints

Ìfàṣẹ́pọ̀

Fi bọ́kì kọ́kọ́ (bearer token) ránṣẹ́ gẹ́gẹ́ bí àmì ìdánimọ̀ API. Ibùdó yìí kò sọ àṣẹ pàtó kan nínú àlàyé rẹ̀, nítorí náà fún kọ́kọ́ rẹ̀ ní ohun tó kéré jù lọ tí ó nílò kí o sì ṣàyẹ̀wò ìdáhùn náà dípò kí o kàn rò ó.

Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

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

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

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

Àwọn ìpìlẹ̀

OrúkọIruTí a nílòKini o jẹ
orderId (path)UuidBẹẹniThe order's id.

Idahun

OrúkọIruTí a nílòKini o jẹ
idUuidBẹẹniUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidBẹẹniUUIDv7 identifier — sortable by creation time (docs/02 §8).
human_refstringBẹẹniHuman-friendly order reference.
statusOrderStatusBẹẹniAn order's lifecycle state (docs/31 §4.3).
currencyCurrencyCodeBẹẹniISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
subtotal_minorintegerBẹẹni
tax_minorintegerBẹẹni
discount_minorintegerBẹẹni
total_minorintegerBẹẹni
billing_countryobjectBẹẹkọ
placed_atobjectBẹẹkọ
created_atstringBẹẹni
updated_atstringBẹẹkọ
linesOrderLine[]Bẹẹni
paymentsPayment[]Bẹẹni

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 404 · 429