Naar hoofdinhoud gaan
DELETE
Annuleer een verzendorder. Dit roept de API van de vervoerder aan om de order te annuleren en werkt de status van de zending bij naar cancelled. Als je een zending annuleert die al cancelled is, krijg je 200 terug met die zending en wordt de vervoerder maar één keer aangeroepen. De response bevat Idempotent-Replayed: true, zodat je een herhaling kunt onderscheiden van de aanroep die het werk heeft gedaan. Zie Idempotentie.
Zendingen kunnen na het ophalen niet meer worden geannuleerd — dat geeft 409 Conflict terug.
Een DHL-retourlabel kan niet op zichzelf worden geannuleerd; ook dat geeft 409 Conflict terug. Annuleer in plaats daarvan het uitgaande pakket. Als je een uitgaand DHL-pakket annuleert, worden ook de pending retourrijen ervan geannuleerd. Elke rij wordt cancelled met een RETURN_LEG_CANCELLED-vermelding in status_updates. Zie Retourlabels. In een doos met meerdere kits heeft elke kit een eigen uitgaande rij en een eigen retourlabel, zelfs als de doos op het label van één kit meereist. Als je de uitgaande rij van een kit annuleert, wordt ook het retourlabel van die kit geannuleerd. Om een pakket met een thuistestkit te annuleren, moet elke gekoppelde bestelling voor een thuistestkit binnen je toegangscontext vallen. Anders geeft de aanroep 403 terug. Zie Toegang.

Verzoek

Padparameters

string
vereist
Referentie-ID van de zending (bijv. P2611194821).

Respons

Bij succes geeft de API 200 OK terug met het geannuleerde zendingobject.
string
vereist
Referentie-identifier van de zending.
string
vereist
Status in de levenscyclus van de zending. Is cancelled na een geslaagde annulering.
string
vereist
Vervoerder. Een van go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups of dhl_express. Een pakket met een thuistestkit is dhl_parcel, of dhl_warenpost wanneer het naar het buitenland gaat als Warenpost International.
string
Extern trackingnummer van de vervoerder. Kan null zijn.
string
Vrije tekstbeschrijving van wat er in het pakket zit, zoals opgegeven bij het aanmaken. Kan null zijn.
string
vereist
Wie het label heeft afgedrukt: aniva of external. Alleen aniva-zendingen accepteren deze aanroep.
string
Referentie van het andere pakket in een zending van twee pakketten. null voor een pakket in één richting.
object
Ophaaladres. Kan null zijn.
object
Bezorgadres. Zelfde structuur als origin. Kan null zijn.
object
Gepland ophaalvenster. Kan null zijn.
string
Optionele notities. Kan null zijn.
object[]
vereist
Chronologische levenscyclusgebeurtenissen van de logistieke dienstverlener (oudste eerst). Elk item heeft state, code, detail_code, status, description, location en time. Zie Zending ophalen voor elk veld. Lege array als er nog geen gebeurtenissen zijn waargenomen.
ShipmentAppointmentLink[]
vereist
Afspraken die vóór annulering aan deze zending waren gekoppeld. Elk item is { id, added_at }; zoek elke id op via Afspraak ophalen. Alleen de afspraken binnen je toegangscontext worden vermeld.
ShipmentHomeKitOrderLink[]
vereist
Thuistestbestellingen gekoppeld aan deze zending, oudste koppeling eerst, in dezelfde { id, added_at }-structuur. Alleen de bestellingen binnen je toegangscontext worden vermeld. Lege array voor praktijkpakketten.
string
Wanneer de zending voor het laatst met de vervoerder is gesynchroniseerd, als UTC-tijdstip. null tot de eerste synchronisatie.
string
vereist
Tijdstempel van aanmaken (ISO 8601).
string
Tijdstempel van laatste update (ISO 8601). Kan null zijn.

Foutresponsen