commerce

GET /v1/orders

List orders in scope.

Wszystkie punkty końcowe commerce

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie billing.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Parametry

NazwaTypWymaganeCo to jest
cursor (query)stringNieOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerNieMaximum items to return (page size).
status (query)OrderStatusNieFilter by order status.
org_id (query)UuidNieRestrict to one organization in scope.

Odpowiedź

NazwaTypWymaganeCo to jest
dataOrder[]Tak
pagePageMetaTak

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 422 · 429