commerce

GET /v1/orders/{orderId}

Get an order.

Všechny koncové body commerce

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

NázevTypPožadovánoCo to je
orderId (path)UuidAnoThe order's id.

Odpověď

NázevTypPožadovánoCo to je
idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidAnoUUIDv7 identifier — sortable by creation time (docs/02 §8).
human_refstringAnoHuman-friendly order reference.
statusOrderStatusAnoAn order's lifecycle state (docs/31 §4.3).
currencyCurrencyCodeAnoISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
subtotal_minorintegerAno
tax_minorintegerAno
discount_minorintegerAno
total_minorintegerAno
billing_countryobjectNe
placed_atobjectNe
created_atstringAno
updated_atstringNe
linesOrderLine[]Ano
paymentsPayment[]Ano

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 429