Public API v1 sözleşmesi Gönderiler PA-01

Gönderi listeleme

GET/api/v1/shipments

Amaç

Tenant'ın gönderilerini sayfalı listelemek.

Yetki

Bearer anahtar; liste anahtarın tenant'ına sunucu tarafında kapsanır; filtre kombinasyonu başka tenant kaydı sızdıramaz.

Sorgu parametreleri

(SPA liste sözleşmesiyle aynı; geçersiz filtre sessiz düşürülmez, 422):

Gönderi listeleme çizelgesi
Parametre	Tip / kural	Davranış
`status`	virgüllü liste veya `status[]=`; her üye kanonik durum	`status IN (...)`; geçersiz üye 422
`carrier_account_id`	string, max 26	eşitlik filtresi (tenant kapsamında)
`created_from`	`Y-m-d`	o gün dahil ileri; biçimsiz 422
`created_to`	`Y-m-d`; `created_from`dan önce olamaz	o günün tamamı dahil geri; ters aralık 422
`search`	string, max 64	PREFIX arama: `delivery_no` / `barcode` / `buyer_name`; LIKE jokerleri etkisizdir
`page`	integer >= 1
`per_page`	integer 1..100 (varsayılan 15)	aşım 422

Başarı 200

sayfalama zarfı (data[]/links/meta); satırlar ortak shipment nesnesinin liste projeksiyonudur (latest_event_at dahil; parcels/events yok). Sıralama: created_at azalan (+id azalan).

Hatalar

401, 422 (geçersiz filtre), 429.

kabuk

curl "{{base_url}}/shipments?status=IN_TRANSIT,OUT_FOR_DELIVERY&per_page=25" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer SEVKORA_API_ANAHTARINIZ"