Siirry pääsisältöön
DELETE
Peru lähetystilaus. Tämä kutsuu logistiikkapalveluntarjoajan API:a tilauksen perumiseksi ja päivittää lähetyksen tilaksi cancelled. Jo cancelled-tilassa olevan lähetyksen peruminen palauttaa 200 ja kyseisen lähetyksen, ja palveluntarjoajaa kutsutaan vain kerran. Vastauksessa on Idempotent-Replayed: true, jotta voit erottaa toiston varsinaisen työn tehneestä kutsusta. Katso Idempotenssi.
Lähetyksiä ei voi perua noudon jälkeen — tämä palauttaa 409 Conflict.
DHL-palautustarraa ei voi perua erikseen; myös se palauttaa 409 Conflict. Peru sen sijaan lähtevä paketti. Lähtevän DHL-paketin peruminen peruu myös sen pending-tilassa olevat paluumatkan rivit. Jokaisen tilaksi tulee cancelled, ja status_updates-kenttään lisätään merkintä RETURN_LEG_CANCELLED. Katso Palautustarrat. Laatikossa, jossa on useita pakkauksia, jokaisella pakkauksella on oma lähtevä rivinsä ja oma palautustarransa, vaikka laatikko kulkee yhden pakkauksen tarralla. Pakkauksen lähtevän rivin peruminen peruu myös kyseisen pakkauksen palautustarran. Kotitestipaketin lähetyksen perumiseksi jokaisen linkitetyn kotitestipakettitilauksen on oltava pääsykontekstissasi. Muuten kutsu palauttaa 403. Katso Pääsyoikeudet.

Pyyntö

Polkuparametrit

string
vaadittu
Lähetyksen viitetunnus (esim. P2611194821).

Vastaus

Onnistuessaan API palauttaa 200 OK ja perutun lähetysobjektin.
string
vaadittu
Lähetyksen viitetunniste.
string
vaadittu
Lähetyksen elinkaaren tila. On cancelled onnistuneen perumisen jälkeen.
string
vaadittu
Logistiikkapalveluntarjoaja. Yksi arvoista go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups tai dhl_express. Kotitestipaketin lähetys on dhl_parcel, tai dhl_warenpost, kun se lähetetään ulkomaille Warenpost International -lähetyksenä.
string
Logistiikkapalveluntarjoajan ulkoinen seurantanumero. Voi olla null.
string
Vapaamuotoinen kuvaus paketin sisällöstä sellaisena kuin se annettiin luotaessa. Voi olla null.
string
vaadittu
Kuka tulosti lähetystarran: aniva tai external. Vain aniva-lähetykset hyväksyvät tämän kutsun.
string
Kahden paketin lähetyksen toisen paketin viite. null yhdensuuntaiselle paketille.
object
Nouto-osoite. Voi olla null.
object
Toimitusosoite. Sama rakenne kuin kentässä origin. Voi olla null.
object
Ajoitettu noutoaikaikkuna. Voi olla null.
string
Valinnaiset muistiinpanot. Voi olla null.
object[]
vaadittu
Logistiikkapalveluntarjoajan elinkaaritapahtumat aikajärjestyksessä (vanhin ensin). Jokaisessa merkinnässä on state, code, detail_code, status, description, location ja time. Katso kenttien kuvaukset kohdasta Hae lähetys. Tyhjä taulukko, jos tapahtumia ei ole vielä havaittu.
ShipmentAppointmentLink[]
vaadittu
Ajanvaraukset, jotka oli liitetty tähän lähetykseen ennen peruutusta. Jokainen merkintä on muodossa { id, added_at }; tarkista kunkin id-arvon tiedot päätepisteestä Hae ajanvaraus. Vain käyttöoikeusalueeseesi kuuluvat ajanvaraukset listataan.
ShipmentHomeKitOrderLink[]
vaadittu
Tähän lähetykseen liitetyt kotitestitilaukset, vanhin liitos ensin, samassa { id, added_at } -muodossa. Vain käyttöoikeusalueeseesi kuuluvat tilaukset listataan. Tyhjä taulukko vastaanottojen paketeille.
string
Milloin lähetys täsmäytettiin viimeksi kuljetusyhtiön kanssa (UTC-ajankohta). null ensimmäiseen synkronointiin asti.
string
vaadittu
Luontiaikaleima (ISO 8601).
string
Viimeisimmän päivityksen aikaleima (ISO 8601). Voi olla null.

Virhevastaukset