commerce

GET /v1/orders

List orders in scope.

Alle commerce-eindpunten

Authenticatie

Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie billing.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.

Waar je organisatie-id komt te staan

Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.

Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.

Probeer het

Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.

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

Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console

Details

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

Parameters

NaamTypeVerplichtWat dit is
cursor (query)stringNeeOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNeeMaximum items to return (page size).
status (query)OrderStatusNeeFilter by order status.
org_id (query)UuidNeeRestrict to one organization in scope.

Reactie

NaamTypeVerplichtWat dit is
dataOrder[]Ja
pagePageMetaJa

Fouten die dit eindpunt kan retourneren

401 · 403 · 422 · 429