commerce

GET /v1/orders

List orders in scope.

Minden commerce végpont

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

A szervezet azonosítójának helye

Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

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

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

Paraméterek

NévTípusKötelezőMi ez
cursor (query)stringNemOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNemMaximum items to return (page size).
status (query)OrderStatusNemFilter by order status.
org_id (query)UuidNemRestrict to one organization in scope.

Válasz

NévTípusKötelezőMi ez
dataOrder[]Igen
pagePageMetaIgen

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 422 · 429