Siirry pääsisältöön
PATCH
Päivitä lähetyksen tietoja, kuten noutoaikataulua, pakettien määrää tai lisätietoja. Jos jokin logistiikan kannalta olennainen kenttä muuttuu (noutopäivä, kellonaika, pakettien määrä tai paino), nykyinen logistiikkatilaus peruutetaan ja uusi luodaan automaattisesti. Kentät, jotka jätät pois, säilyvät nykyisestä lähetyksestä. Päivitetyt aikataulukentät tarkistetaan noutoaikataulun sääntöjen mukaisesti.
Lähetyksiä ei voi muokata noudon jälkeen. Jo noudetun lähetyksen päivitysyritys palauttaa tilakoodin 409 Conflict.
Kotitestipakkauksen lähetyksellä on jo tulostettu osoitekortti, joten vain notes-kenttää voi muuttaa. Uusi noutoaikaikkuna tai paino kotitestipakkauksen lähetykselle palauttaa tilakoodin 409 Conflict; peruuta se ja luo sen sijaan uusi lähetys. Kotitestipakkauksen lähetyksen päivittäminen edellyttää, että jokainen siihen linkitetty kotitestipakkauksen tilaus kuuluu pääsykontekstiisi. Muuten kutsu palauttaa tilakoodin 403. Katso Pääsyoikeudet.

Pyyntö

Polkuparametrit

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

Runkoparametrit

Kaikki runkoparametrit ovat valinnaisia — sisällytä vain kentät, joita haluat muuttaa.
string
Uusi noutopäivä muodossa YYYY-MM-DD lähtöpaikan aikavyöhykkeen mukaan.
string
Uusi aikaisin noutoaika muodossa HH:MM, joka tulkitaan paikalliseksi kellonajaksi lähtöpaikan aikavyöhykkeellä.
string
Uusi myöhäisin noutoaika muodossa HH:MM, joka tulkitaan paikalliseksi kellonajaksi lähtöpaikan aikavyöhykkeellä.
integer
Uusi pakettien määrä.
number
Uusi paino (kg).
string
Uudet lisätiedot tai huomautukset. Enintään 128 merkkiä.

Vastaus

Onnistuessaan API palauttaa tilakoodin 200 OK ja päivitetyn lähetyksen.
string
vaadittu
Lähetyksen viitetunniste.
string
vaadittu
Lähetyksen elinkaaritila. Yksi arvoista pending, in_transit, delivered, fault tai cancelled.
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
Tähän lähetykseen linkitetyt ajanvaraukset, vanhin linkitys ensin. Jokainen merkintä on { id, added_at }; hae tiedot kullekin id-arvolle kutsulla Hae ajanvaraus. Vain pääsykontekstiisi 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