Spring til hovedindhold
PATCH
Opdater forsendelsesoplysninger som afhentningstidspunkt, antal pakker eller noter. Hvis logistikrelevante felter ændres (afhentningsdato, tidspunkt, antal pakker eller vægt), annulleres den eksisterende logistikordre, og der oprettes automatisk en ny. Felter, du udelader, bevares fra den eksisterende forsendelse. Opdaterede felter for afhentningstidspunkt valideres mod reglerne for afhentningstidspunkter.
Forsendelser kan ikke ændres efter afhentning. Forsøg på at opdatere en forsendelse, der allerede er afhentet, returnerer 409 Conflict.
En hjemmetestkitpakke har allerede fået udskrevet sin label, så kun notes kan ændres. Et nyt afhentningsvindue eller en ny vægt på en hjemmetestkitpakke returnerer 409 Conflict; annuller den, og opret en ny forsendelse i stedet. For at opdatere en hjemmetestkitpakke skal alle tilknyttede hjemmetestkitordrer være i din adgangskontekst. Ellers returnerer kaldet 403. Se Adgang.

Forespørgsel

Stiparametre

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

Body-parametre

Alle body-parametre er valgfri — inkluder kun de felter, du vil ændre.
string
Ny afhentningsdato i formatet YYYY-MM-DD, fortolket i afsendelsesstedets tidszone.
string
Nyt tidligste afhentningstidspunkt i formatet HH:MM, fortolket som lokalt klokkeslæt i afsendelsesstedets tidszone.
string
Nyt seneste afhentningstidspunkt i formatet HH:MM, fortolket som lokalt klokkeslæt i afsendelsesstedets tidszone.
integer
Nyt antal pakker.
number
Ny vægt i kg.
string
Nye noter eller bemærkninger. Maksimalt 128 tegn.

Svar

Ved succes returnerer API’et 200 OK med den opdaterede forsendelse.
string
påkrævet
Forsendelsens reference-id.
string
påkrævet
Forsendelsens livscyklusstatus. En af pending, in_transit, delivered, fault eller cancelled.
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 tilknyttet denne forsendelse, med den ældste tilknytning først. Hvert element er { id, added_at }; slå hvert id op i 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