commerce

GET /v1/orders/{orderId}

Get an order.

Semua titik akhir commerce

Pengesahan

Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.

Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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

Parameter

NamaJenisDiperlukanApakah ia
orderId (path)UuidYaThe order's id.

Respons

NamaJenisDiperlukanApakah ia
idUuidYaUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidYaUUIDv7 identifier — sortable by creation time (docs/02 §8).
human_refstringYaHuman-friendly order reference.
statusOrderStatusYaAn order's lifecycle state (docs/31 §4.3).
currencyCurrencyCodeYaISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
subtotal_minorintegerYa
tax_minorintegerYa
discount_minorintegerYa
total_minorintegerYa
billing_countryobjectTidak
placed_atobjectTidak
created_atstringYa
updated_atstringTidak
linesOrderLine[]Ya
paymentsPayment[]Ya

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 429