Přejít na hlavní obsah
GET
Načte jednu zásilku podle jejího referenčního ID. Odpověď pochází z naší databáze a nikdy nevolá přepravce. Synchronizace na pozadí aktualizuje každou zásilku (každých 10 minut u GO!, každou hodinu u DHL) a synced_at ti ukáže, kdy byl přepravce naposledy dotázán. Vyžaduje scope shipments_view nebo shipments_manage.

Požadavek

Parametry cesty

string
povinné
Referenční ID zásilky (např. P2611194821).

Odpověď

Při úspěchu vrátí API 200 OK s objektem zásilky.
string
povinné
Referenční identifikátor zásilky.
string
povinné
Stav životního cyklu zásilky. Jedna z hodnot pending, in_transit, delivered, fault nebo cancelled.
string
povinné
Poskytovatel logistiky. Jedna z hodnot go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups nebo dhl_express. Balík s domácí sadou je dhl_parcel, případně dhl_warenpost, když jde do zahraničí jako Warenpost International.
string
Externí sledovací číslo od poskytovatele logistiky. Může být null.
string
Volný textový popis obsahu balíku zadaný při vytvoření (např. "Medizinisch freigestellte Probe", "Home test kit"). Pouze informativní — zda balík míří do laboratoře, vyčteš z destination, a jeho protějšek z paired_with. Může být null.
string
povinné
Kdo vytiskl štítek: aniva nebo external. Pouze zásilky aniva podporují Aktualizaci a Zrušení; balík external je sledovaný, ale u obou vrátí 501.
string
Reference druhého balíku z dvoubalíkové zásilky – balíku, který obsahoval štítek pro vrácení, a balíku, který tento štítek vrací zpět. Nastaveno u obou. null u jednosměrného balíku.
object
Adresa vyzvednutí. Může být null.
object
Doručovací adresa. Stejná struktura jako origin. Může být null.
object
Naplánované okno vyzvednutí. Může být null.
string
Volitelné poznámky. Může být null.
object[]
povinné
Chronologické události životního cyklu od logistického poskytovatele (od nejstarší). Prázdné pole, pokud poskytovatel ještě žádné události neohlásil. Použij je pro zobrazení jednotlivých událostí v UI, audit a jemnější signály dopravce; pro aktuální kanonický stav se spolehni na status.
ShipmentAppointmentLink[]
povinné
Termíny propojené s touto zásilkou, od nejstaršího propojení. Každá položka má tvar { id, added_at }; každé id si dohledej přes Získat termín pro kompletní data termínu. Prázdné pole, když nejsou propojené žádné termíny. Uvedeny jsou pouze termíny v tvém přístupovém kontextu.
ShipmentHomeKitOrderLink[]
povinné
Objednávky domácích testovacích sad propojené s touto zásilkou, od nejstaršího propojení, ve stejném tvaru { id, added_at }. Každé id si dohledej přes Získat objednávku domácí testovací sady. Prázdné pole pro balíky z ordinací. Uvedeny jsou pouze objednávky v tvém přístupovém kontextu. Viz Přístup.
string
Čas posledního sladění zásilky s dopravcem v UTC. Čtení nikdy nevolá dopravce – zásilky udržuje aktuální synchronizace na pozadí – takže tento údaj říká, jak stará je odpověď. null až do první synchronizace.
string
povinné
Časové razítko vytvoření (ISO 8601).
string
Časové razítko poslední aktualizace (ISO 8601). Může být null.

Opakovaná volání

Aniva ukládá odpověď tohoto endpointu pro každý API klíč na 60 minut. Opakované volání během této doby dostane uloženou odpověď, dokud se zásilka nezmění. Po změně dostaneš čerstvou odpověď. Hlavičky Cache-Status a Age ukazují, že je odpověď uložená a jak je stará. V uložené odpovědi mohou být synced_at a updated_at starší než v čerstvé odpovědi. Pokud se chceš o změně dozvědět hned, přihlas se k odběru webhookových událostí shipment.created a shipment.updated. Viz Opakované čtení.

Chybové odpovědi