commerce

GET /v1/orders

List orders in scope.

Tüm commerce uç noktaları

Kimlik Doğrulama

Bearer token olarak bir API anahtarı gönderin. Anahtar billing.view iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.

Kurum kimliğinizin yazılacağı yer

Bu uç nokta, org_id parametresini bir sorgu parametresi olarak alır. Bu parametreyi dışarıda bırakırsanız çağrı tüm kiracı alt ağacınızı kapsar; çağrıyı tek bir kuruluşa daraltmak için gönderin.

Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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

Parametreler

AdTürZorunluNe olduğu
cursor (query)stringHayırOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerHayırMaximum items to return (page size).
status (query)OrderStatusHayırFilter by order status.
org_id (query)UuidHayırRestrict to one organization in scope.

Yanıt

AdTürZorunluNe olduğu
dataOrder[]Evet
pagePageMetaEvet

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 422 · 429