Hoppa till huvudinnehåll
PATCH
Uppdatera uppgifter för försändelsen, såsom upphämtningsschema, antal paket eller anteckningar. Om några logistikrelevanta fält ändras (upphämtningsdatum, tid, antal paket eller vikt) avbokas den befintliga logistikordern och en ny skapas automatiskt. Fält som du utelämnar behålls från den befintliga försändelsen. Uppdaterade schemafält valideras mot reglerna för upphämtningsschema.
Försändelser kan inte ändras efter upphämtning. Försök att uppdatera en försändelse som redan har hämtats upp returnerar 409 Conflict.
Ett paket med hemtestkit har redan sin etikett utskriven, så bara notes kan ändras. Ett nytt upphämtningsfönster eller en ny vikt på ett paket med hemtestkit returnerar 409 Conflict; avboka det och skapa en ny försändelse istället. För att uppdatera ett paket med hemtestkit måste varje kopplad beställning av hemtestkit ingå 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).

Body-parametrar

Alla body-parametrar är valfria – ta bara med de fält du vill ändra.
string
Nytt upphämtningsdatum i formatet YYYY-MM-DD, tolkat i avsändarplatsens tidszon.
string
Ny tidigaste upphämtningstid i formatet HH:MM, tolkad som lokalt klockslag i avsändarplatsens tidszon.
string
Ny senaste upphämtningstid i formatet HH:MM, tolkad som lokalt klockslag i avsändarplatsens tidszon.
integer
Nytt antal paket.
number
Ny vikt i kg.
string
Nya anteckningar eller anmärkningar. Max 128 tecken.

Svar

Vid lyckat anrop returnerar API:et 200 OK med den uppdaterade försändelsen.
string
obligatorisk
Försändelsens referensidentifierare.
string
obligatorisk
Försändelsens livscykelstatus. Ett av pending, in_transit, delivered, fault eller cancelled.
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 kopplade till denna försändelse, äldsta kopplingen först. Varje post är { id, added_at }; slå upp varje id med 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