Přejít na hlavní obsah
DELETE
Zruš objednávku zásilky. Tím se zavolá API poskytovatele logistiky pro zrušení objednávky a stav zásilky se aktualizuje na cancelled. Zrušení zásilky, která už je cancelled, vrátí 200 s touto zásilkou a poskytovatel se zavolá jen jednou. Odpověď obsahuje Idempotent-Replayed: true, takže poznáš opakované volání od toho, které akci provedlo. Viz Idempotence.
Zásilky nelze po vyzvednutí zrušit — vrátí se 409 Conflict.
Zpáteční štítek DHL nelze zrušit samostatně; i to vrátí 409 Conflict. Místo toho zruš odchozí balík. Zrušením odchozího balíku DHL se zruší i jeho řádky zpáteční cesty ve stavu pending. Každý z nich přejde na cancelled se záznamem RETURN_LEG_CANCELLED v status_updates. Viz Zpáteční štítky. V krabici s několika sadami má každá sada vlastní odchozí řádek a vlastní zpáteční štítek, i když krabice cestuje na štítek jedné sady. Zrušením odchozího řádku sady se zruší i její zpáteční štítek. Pro zrušení balíku s domácí sadou musí být každá propojená objednávka domácí sady v tvém přístupovém kontextu. Jinak volání vrátí 403. Viz Přístup.

Požadavek

Parametry cesty

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

Odpověď

Při úspěchu API vrátí 200 OK s objektem zrušené zásilky.
string
povinné
Referenční identifikátor zásilky.
string
povinné
Stav životního cyklu zásilky. Po úspěšném zrušení bude 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í. Může být null.
string
povinné
Kdo štítek vytiskl: aniva nebo external. Toto volání přijímají jen zásilky aniva.
string
Reference druhého balíku zásilky se dvěma balíky. Pro jednosměrný balík je null.
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 poskytovatele logistiky (od nejstarší). Každá položka má state, code, detail_code, status, description, location a time. Jednotlivá pole najdeš v Získat zásilku. Prázdné pole, pokud zatím nebyly zaznamenány žádné události.
ShipmentAppointmentLink[]
povinné
Termíny, které byly k této zásilce přiřazeny před zrušením. Každá položka má tvar { id, added_at }; každé id dohledej přes Získat termín. Uvedeny jsou pouze termíny v tvém přístupovém kontextu.
ShipmentHomeKitOrderLink[]
povinné
Objednávky domácích sad přiřazené k této zásilce, od nejstaršího přiřazení, ve stejném tvaru { id, added_at }. Uvedeny jsou pouze objednávky v tvém přístupovém kontextu. Prázdné pole pro balíky z ordinací.
string
Kdy byla zásilka naposledy sladěna s přepravcem, jako okamžik v UTC. 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.

Chybové odpovědi