commerce

GET /v1/orders/{orderId}

Get an order.

Minden commerce végpont

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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

Paraméterek

NévTípusKötelezőMi ez
orderId (path)UuidIgenThe order's id.

Válasz

NévTípusKötelezőMi ez
idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
human_refstringIgenHuman-friendly order reference.
statusOrderStatusIgenAn order's lifecycle state (docs/31 §4.3).
currencyCurrencyCodeIgenISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
subtotal_minorintegerIgen
tax_minorintegerIgen
discount_minorintegerIgen
total_minorintegerIgen
billing_countryobjectNem
placed_atobjectNem
created_atstringIgen
updated_atstringNem
linesOrderLine[]Igen
paymentsPayment[]Igen

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 429