commerce

GET /v1/orders

List orders in scope.

Lahat ng commerce endpoint

Pagpapatotoo

Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na billing.view; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.

Kung saan mapupunta ang id ng iyong organisasyon

Tinatanggap ng endpoint na ito ang org_id bilang parameter ng query. Huwag itong isama at saklaw ng tawag ang buong subtree ng iyong tenancy; ipadala ito para paliitin ang tawag sa isang organisasyon.

Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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

Mga Parameter

PangalanUriKailanganAno ito
cursor (query)stringHindiOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerHindiMaximum items to return (page size).
status (query)OrderStatusHindiFilter by order status.
org_id (query)UuidHindiRestrict to one organization in scope.

Tugon

PangalanUriKailanganAno ito
dataOrder[]Oo
pagePageMetaOo

Mga error na maibabalik ng endpoint na ito

401 · 403 · 422 · 429