Hopp til hovedinnhold
DELETE
Kanseller en forsendelsesordre. Dette kaller logistikkleverandørens API for å kansellere ordren og oppdaterer forsendelsesstatusen til cancelled. Å kansellere en forsendelse som allerede er cancelled, returnerer 200 med den forsendelsen, og leverandøren kalles bare én gang. Svaret inneholder Idempotent-Replayed: true, slik at du kan skille en gjentakelse fra kallet som utførte handlingen. Se Idempotens.
Forsendelser kan ikke kanselleres etter henting — det returnerer 409 Conflict.
En DHL-returetikett kan ikke kanselleres alene; det returnerer også 409 Conflict. Kanseller utgående pakke i stedet. Når du kansellerer en utgående DHL-pakke, kanselleres også pending-radene for returen. Hver av dem får status cancelled med en RETURN_LEG_CANCELLED-oppføring i status_updates. Se Returetiketter. I en eske med flere sett har hvert sett sin egen utgående rad og sin egen returetikett, selv når esken sendes med etiketten til ett av settene. Når du kansellerer den utgående raden for et sett, kanselleres også returetiketten for det settet. For å kansellere en hjemmesettpakke må hver tilknyttet hjemmesettbestilling være i tilgangskonteksten din. Ellers returnerer kallet 403. Se Tilgang.

Forespørsel

Stiparametere

string
påkrevd
Forsendelsens referanse-ID (f.eks. P2611194821).

Respons

Ved suksess returnerer API-et 200 OK med det kansellerte forsendelsesobjektet.
string
påkrevd
Referanseidentifikator for forsendelsen.
string
påkrevd
Livssyklusstatus for forsendelsen. Vil være cancelled etter en vellykket kansellering.
string
påkrevd
Logistikkleverandør. Én av go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups eller dhl_express. En hjemmesettpakke er dhl_parcel, eller dhl_warenpost når den sendes utenlands som Warenpost International.
string
Eksternt sporingsnummer fra logistikkleverandøren. Kan være null.
string
Fritekstbeskrivelse av hva som er i pakken, slik den ble oppgitt ved opprettelse. Kan være null.
string
påkrevd
Hvem som skrev ut etiketten: aniva eller external. Bare aniva-forsendelser godtar dette kallet.
string
Referanse til den andre pakken i en sending med to pakker. null for en enveispakke.
object
Henteadresse. Kan være null.
object
Leveringsadresse. Samme struktur som origin. Kan være null.
object
Planlagt hentevindu. Kan være null.
string
Valgfrie notater. Kan være null.
object[]
påkrevd
Kronologiske livssyklushendelser fra logistikkleverandøren (eldste først). Hver oppføring har state, code, detail_code, status, description, location og time. Se Hent forsendelse for hvert felt. Tom liste hvis ingen hendelser er registrert ennå.
ShipmentAppointmentLink[]
påkrevd
Timer som var koblet til denne forsendelsen før kansellering. Hver oppføring er { id, added_at }; kryssreferer hver id mot Hent time. Bare timene i tilgangskonteksten din vises.
ShipmentHomeKitOrderLink[]
påkrevd
Hjemmetestbestillinger koblet til denne forsendelsen, eldste kobling først, med samme { id, added_at }-struktur. Bare bestillingene i tilgangskonteksten din vises. Tom liste for pakker fra praksiser.
string
Når forsendelsen sist ble avstemt med transportøren, som et UTC-tidspunkt. null frem til første synkronisering.
string
påkrevd
Tidsstempel for opprettelse (ISO 8601).
string
Tidsstempel for siste oppdatering (ISO 8601). Kan være null.

Feilresponser