Hoppa till huvudinnehåll
DELETE
Avboka en försändelseorder. Det här anropar logistikleverantörens API för att avboka ordern och uppdaterar försändelsens status till cancelled. Att avboka en försändelse som redan har statusen cancelled returnerar 200 med den försändelsen, och leverantören anropas bara en gång. Svaret innehåller Idempotent-Replayed: true så att du kan skilja en upprepning från det anrop som utförde åtgärden. Se Idempotens.
Försändelser kan inte avbokas efter upphämtning – det returnerar 409 Conflict.
En DHL-returetikett kan inte avbokas på egen hand; det returnerar också 409 Conflict. Avboka det utgående paketet i stället. När ett utgående DHL-paket avbokas avbokas även dess pending-rader för retursändningen. Var och en får statusen cancelled med en RETURN_LEG_CANCELLED-post i status_updates. Se Returetiketter. I en låda med flera kit har varje kit sin egen utgående rad och sin egen returetikett, även när lådan skickas med ett av kitens etikett. Om du avbokar ett kits utgående rad avbokas även det kitets returetikett. För att avboka ett paket med hemtestkit måste varje kopplad beställning av hemtestkit finnas i din åtkomstkontext. Annars returnerar anropet 403. Se Åtkomst.

Förfrågan

Sökvägsparametrar

string
obligatorisk
Försändelsens referens-ID (t.ex. P2611194821).

Svar

Vid lyckat anrop returnerar API:et 200 OK med det avbokade försändelseobjektet.
string
obligatorisk
Försändelsens referensidentifierare.
string
obligatorisk
Försändelsens livscykelstatus. Blir cancelled efter en lyckad avbokning.
string
obligatorisk
Logistikleverantör. Ett av go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups eller dhl_express. Ett paket med hemtestkit använder dhl_parcel, eller dhl_warenpost när det skickas utomlands som Warenpost International.
string
Externt spårningsnummer från logistikleverantören. Kan vara null.
string
Fritextbeskrivning av paketets innehåll, som angavs vid skapandet. Kan vara null.
string
obligatorisk
Vem som skrev ut etiketten: aniva eller external. Bara aniva-försändelser accepterar det här anropet.
string
Referens till det andra paketet i en sändning med två paket. null för ett enkelriktat paket.
object
Upphämtningsadress. Kan vara null.
object
Leveransadress. Samma struktur som origin. Kan vara null.
object
Schemalagt upphämtningsfönster. Kan vara null.
string
Valfria anteckningar. Kan vara null.
object[]
obligatorisk
Kronologiska livscykelhändelser från logistikleverantören (äldsta först). Varje post har state, code, detail_code, status, description, location och time. Se Hämta försändelse för respektive fält. Tom array om inga händelser har observerats ännu.
ShipmentAppointmentLink[]
obligatorisk
Bokningar som var kopplade till den här försändelsen före avbokningen. Varje post är { id, added_at }; stäm av varje id mot Hämta bokning. Endast bokningarna i din åtkomstkontext listas.
ShipmentHomeKitOrderLink[]
obligatorisk
Beställningar av hemtestkit som är kopplade till den här försändelsen, äldsta kopplingen först, med samma { id, added_at }-struktur. Endast beställningarna i din åtkomstkontext listas. Tom array för paket från mottagningar.
string
När försändelsen senast stämdes av mot sin transportör, som en UTC-tidpunkt. null fram till den första synkroniseringen.
string
obligatorisk
Tidsstämpel för skapande (ISO 8601).
string
Tidsstämpel för senaste uppdatering (ISO 8601). Kan vara null.

Felsvar