commerce

GET /v1/orders

List orders in scope.

Всички крайни точки в commerce

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението billing.view; ключ без него се отхвърля с 403, а не с 404.

Където отива идентификаторът на вашата организация

Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.

ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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

Параметри

ИмеТипЗадължителноКакво представлява
cursor (query)stringНеOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerНеMaximum items to return (page size).
status (query)OrderStatusНеFilter by order status.
org_id (query)UuidНеRestrict to one organization in scope.

Отговор

ИмеТипЗадължителноКакво представлява
dataOrder[]Да
pagePageMetaДа

Грешки, които този крайpoint може да върне

401 · 403 · 422 · 429