Hopp til hovedinnhold
PATCH
Oppdater forsendelsesdetaljer som hentetidspunkt, antall pakker eller notater. Hvis logistikkrelevante felter endres (hentedato, klokkeslett, antall pakker eller vekt), kanselleres den eksisterende logistikkordren og en ny opprettes automatisk. Felter du utelater, beholdes fra den eksisterende forsendelsen. Oppdaterte felter for hentetidspunkt valideres mot reglene for hentetidspunkt.
Forsendelser kan ikke endres etter henting. Forsøk på å oppdatere en forsendelse som allerede er hentet, returnerer 409 Conflict.
En pakke med hjemmetestsett har allerede en utskrevet etikett, så bare notes kan endres. Et nytt hentevindu eller ny vekt på en pakke med hjemmetestsett returnerer 409 Conflict; kanseller den og opprett en ny forsendelse i stedet. For å oppdatere en pakke med hjemmetestsett må hver tilknyttede bestilling av hjemmetestsett være i din tilgangskontekst. Ellers returnerer kallet 403. Se Tilgang.

Forespørsel

Stiparametere

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

Body-parametere

Alle body-parametere er valgfrie – ta bare med feltene du vil endre.
string
Ny hentedato i YYYY-MM-DD-format, tolket i avsenderstedets tidssone.
string
Nytt tidligste hentetidspunkt i HH:MM-format, tolket som lokal klokketid i avsenderstedets tidssone.
string
Nytt seneste hentetidspunkt i HH:MM-format, tolket som lokal klokketid i avsenderstedets tidssone.
integer
Nytt antall pakker.
number
Ny vekt i kg.
string
Nye notater eller merknader. Maksimalt 128 tegn.

Respons

Ved suksess returnerer API-et 200 OK med den oppdaterte forsendelsen.
string
påkrevd
Referanseidentifikator for forsendelsen.
string
påkrevd
Livssyklusstatus for forsendelsen. En av pending, in_transit, delivered, fault eller cancelled.
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 knyttet til denne forsendelsen, med eldste kobling først. Hver oppføring er { id, added_at }; slå opp hver id i Hent time. Bare timene i din tilgangskontekst 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