Zaslat API v1
Sledování zásilek a stavy
Rozšířená specifikace
Jedná se o rozšířenou specifikaci API dokumentace pro endpointy shipments/tracking,
shipments/detail a shipments/list.
Životní cyklus zásilky
Zásilka prochází stavy v tomto pořadí (číselník ShipmentStatus):
| Stav | Popis |
|---|---|
CREATED | Zásilka vytvořena v systému Zaslat. |
EXPORTED | Dopravce potvrdil přijetí dat o zásilce — od této chvíle je dostupný štítek. |
ONPICKUP | Zásilka čeká na svoz kurýrem. |
INTRANSIT | Zásilka na cestě do cílového depa. |
ONDELIVERY | Zásilka předána kurýrovi k doručení. |
DELIVERED | Zásilka doručena. |
CANCELLED | Zásilka zrušena (stornována). |
Stav má jak zásilka, tak každý její balík zvlášť. Tracking odpověď navíc obsahuje příznak
returned — true znamená, že zásilka byla vrácena odesílateli.
Jak stav zjistit
POST /shipments/tracking— aktuální stav a kompletní historie tracking událostí. Pro každý balík zásilky vrací samostatné pole událostí (datum, čas, popis, stav, místo).POST /shipments/detail?tracking— detail zásilek; s query parametremtrackingodpověď u každé zásilky obsahuje navíc poletracking_informationse stejným obsahem jakoshipments/tracking. Ušetříte tak druhé volání, pokud potřebujete detail i historii.GET /shipments/list?tracking— stránkovaný seznam zásilek, parametrtrackingfunguje stejně. Seznam lze filtrovat podle stavu (status=OPEN|ACTIVE|DELIVERED|STORNO), data vytvoření nebo vlastní reference.
Doporučený způsob integrace
API v1 nenabízí webhooky (odchozí HTTP notifikace o změně stavu). Stav zásilek zjišťujte dotazováním (pollingem):
- Pro průběžnou synchronizaci většího množství zásilek použijte
GET /shipments/list?trackings filtremstatus=ACTIVE— jedním voláním získáte stav všech aktivních zásilek. - Pro jednotlivé zásilky použijte
POST /shipments/trackings dávkou identifikátorů (endpoint přijímá poleshipments). - Tracking data se přebírají od dopravců průběžně — pro běžnou integraci je dostačující dotazovat se v intervalu desítek minut.
E-mailové notifikace o vyzvednutí, problému či doručení (odesílateli i příjemci) lze zapnout ve správním rozhraní (app.zaslat.cz).
Příklad dotazu
Code
Odpověď (zkráceno na jednu zásilku):
Code
Události jsou řazené od nejnovější; klíčem objektu data je identifikátor zásilky
(tracking_number).
Last modified on