commerce

GET /v1/orders

List orders in scope.

Усі кінцеві точки commerce

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл billing.view; ключ без нього відхиляється з кодом 403, а не 404.

Де вказується ідентифікатор вашої організації

Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.

Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

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

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі 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Так

Помилки, які може повертати ця кінцева точка

401 · 403 · 422 · 429