Spring til hovedindhold
DELETE
Annuller en forsendelsesordre. Dette kalder logistikudbyderens API for at annullere ordren og opdaterer forsendelsesstatus til cancelled. Hvis du annullerer en forsendelse, der allerede er cancelled, returneres 200 med den pågældende forsendelse, og udbyderen kaldes kun én gang. Svaret indeholder Idempotent-Replayed: true, så du kan skelne en gentagelse fra det kald, der udførte handlingen. Se Idempotens.
Forsendelser kan ikke annulleres efter afhentning – det returnerer 409 Conflict.
En DHL-returlabel kan ikke annulleres alene; det returnerer også 409 Conflict. Annuller den udgående pakke i stedet. Når du annullerer en udgående DHL-pakke, annulleres dens pending returrækker også. Hver af dem bliver cancelled med en RETURN_LEG_CANCELLED-post i status_updates. Se Returlabels. I en kasse med flere kits har hvert kit sin egen udgående række og sin egen returlabel, selv når kassen sendes på ét kits label. Når du annullerer et kits udgående række, annulleres også dette kits returlabel. For at annullere en hjemmekit-pakke skal hver tilknyttet hjemmekit-ordre være i din adgangskontekst. Ellers returnerer kaldet 403. Se Adgang.

Forespørgsel

Stiparametre

string
påkrævet
Forsendelsens reference-ID (f.eks. P2611194821).

Svar

Ved succes returnerer API’et 200 OK med det annullerede forsendelsesobjekt.
string
påkrævet
Forsendelsens reference-id.
string
påkrævet
Forsendelsens livscyklusstatus. Vil være cancelled efter en vellykket annullering.
string
påkrævet
Logistikudbyder. En af go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups eller dhl_express. En hjemmekit-pakke er dhl_parcel, eller dhl_warenpost, når den sendes til udlandet som Warenpost International.
string
Eksternt sporingsnummer fra logistikudbyderen. Kan være null.
string
Fritekstbeskrivelse af pakkens indhold, som angivet ved oprettelsen. Kan være null.
string
påkrævet
Hvem der udskrev labelen: aniva eller external. Kun aniva-forsendelser accepterer dette kald.
string
Reference til den anden pakke i en forsendelse med to pakker. null for en enkeltvejspakke.
object
Afhentningsadresse. Kan være null.
object
Leveringsadresse. Samme struktur som origin. Kan være null.
object
Planlagt afhentningstidsrum. Kan være null.
string
Valgfrie noter. Kan være null.
object[]
påkrævet
Kronologiske livscyklushændelser fra logistikudbyderen (ældste først). Hver post har state, code, detail_code, status, description, location og time. Se Hent forsendelse for hvert felt. Tomt array, hvis der endnu ikke er registreret hændelser.
ShipmentAppointmentLink[]
påkrævet
Tider, der var tilknyttet denne forsendelse før annullering. Hver post er { id, added_at }; slå hvert id op via Hent tid. Kun tider i din adgangskontekst vises.
ShipmentHomeKitOrderLink[]
påkrævet
Hjemmetestordrer tilknyttet denne forsendelse, ældste tilknytning først, i samme { id, added_at }-format. Kun ordrer i din adgangskontekst vises. Tomt array for praksispakker.
string
Hvornår forsendelsen sidst blev afstemt med fragtfirmaet, som UTC-tidspunkt. null indtil første synkronisering.
string
påkrævet
Tidsstempel for oprettelse (ISO 8601).
string
Tidsstempel for seneste opdatering (ISO 8601). Kan være null.

Fejlsvar