commerce

GET /v1/orders

List orders in scope.

Semua titik akhir commerce

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran billing.view; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.

Tempat ID organisasi anda diletakkan

Titik akhir ini mengambil org_id sebagai parameter pertanyaan. Biarkan ia kosong dan panggilan tersebut meliputi keseluruhan subpohon penyewaan anda; hantarkannya untuk mengecilkan panggilan kepada satu organisasi.

ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.

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 \
  -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

The organization's orders, newest reachable by paging. Requires `billing.view`.

Parameter

NamaJenisDiperlukanApakah ia
cursor (query)stringTidakOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerTidakMaximum items to return (page size).
status (query)OrderStatusTidakFilter by order status.
org_id (query)UuidTidakRestrict to one organization in scope.

Respons

NamaJenisDiperlukanApakah ia
dataOrder[]Ya
pagePageMetaYa

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 422 · 429