Zum Hauptinhalt springen
PATCH
Aktualisiere Sendungsdetails wie Abholzeitplan, Paketanzahl oder Notizen. Wenn sich logistikrelevante Felder ändern (Abholdatum, Uhrzeit, Paketanzahl oder Gewicht), wird der bestehende Logistikauftrag storniert und automatisch ein neuer erstellt. Weggelassene Felder werden von der bestehenden Sendung übernommen. Aktualisierte Zeitplanfelder werden anhand der Regeln für den Abholzeitplan geprüft.
Sendungen können nach der Abholung nicht mehr geändert werden. Der Versuch, eine bereits abgeholte Sendung zu aktualisieren, gibt 409 Conflict zurück.
Ein Heimtest-Kit-Paket hat bereits ein gedrucktes Etikett, daher kann nur notes geändert werden. Ein neues Abholzeitfenster oder Gewicht bei einem Heimtest-Kit-Paket gibt 409 Conflict zurück; storniere es stattdessen und erstelle eine neue Sendung. Um ein Heimtest-Kit-Paket zu aktualisieren, muss jede verknüpfte Heimtest-Kit-Bestellung in deinem Zugriffskontext liegen. Andernfalls gibt der Aufruf 403 zurück. Siehe Zugriff.

Anfrage

Pfadparameter

string
erforderlich
Referenz-ID der Sendung (z. B. P2611194821).

Body-Parameter

Alle Body-Parameter sind optional – gib nur die Felder an, die du ändern möchtest.
string
Neues Abholdatum im Format YYYY-MM-DD, interpretiert in der Zeitzone des Abholorts.
string
Neue früheste Abholzeit im Format HH:MM, interpretiert als Ortszeit in der Zeitzone des Abholorts.
string
Neue späteste Abholzeit im Format HH:MM, interpretiert als Ortszeit in der Zeitzone des Abholorts.
integer
Neue Anzahl der Pakete.
number
Neues Gewicht in kg.
string
Neue Notizen oder Bemerkungen. Maximal 128 Zeichen.

Antwort

Bei Erfolg gibt die API 200 OK mit der aktualisierten Sendung zurück.
string
erforderlich
Referenz-ID der Sendung.
string
erforderlich
Status der Sendung. Einer der Werte pending, in_transit, delivered, fault oder cancelled.
string
erforderlich
Logistikanbieter. Einer der Werte go, dhl_parcel, dhl_warenpost, rotrunner, rapido, ups oder dhl_express. Ein Home-Kit-Paket ist dhl_parcel oder dhl_warenpost, wenn es als Warenpost International ins Ausland geht.
string
Externe Sendungsnummer des Logistikanbieters. Kann null sein.
string
Freitextbeschreibung des Paketinhalts, wie bei der Erstellung angegeben. Kann null sein.
string
erforderlich
Wer das Label gedruckt hat: aniva oder external. Nur aniva-Sendungen akzeptieren diesen Aufruf.
string
Referenz des anderen Pakets bei einer Sendung mit zwei Paketen. null bei einem einfachen Paket.
object
Abholadresse. Kann null sein.
object
Lieferadresse. Gleiche Struktur wie origin. Kann null sein.
object
Geplantes Abholzeitfenster. Kann null sein.
string
Optionale Notizen. Kann null sein.
object[]
erforderlich
Chronologische Statusereignisse des Logistikanbieters (ältestes zuerst). Jeder Eintrag enthält state, code, detail_code, status, description, location und time. Siehe Sendung abrufen für die einzelnen Felder. Leeres Array, wenn noch keine Ereignisse vorliegen.
ShipmentAppointmentLink[]
erforderlich
Mit dieser Sendung verknüpfte Termine, älteste Verknüpfung zuerst. Jeder Eintrag hat die Form { id, added_at }; gleiche jede id mit Termin abrufen ab. Es werden nur die Termine in deinem Zugriffskontext aufgelistet.
ShipmentHomeKitOrderLink[]
erforderlich
Home-Kit-Bestellungen, die mit dieser Sendung verknüpft sind (älteste Verknüpfung zuerst), in derselben Form { id, added_at }. Es werden nur Bestellungen in deinem Zugriffskontext aufgeführt. Leeres Array bei Praxispaketen.
string
Zeitpunkt des letzten Abgleichs der Sendung mit dem Versanddienstleister als UTC-Zeitpunkt. null bis zur ersten Synchronisierung.
string
erforderlich
Erstellungszeitstempel (ISO 8601).
string
Zeitstempel der letzten Aktualisierung (ISO 8601). Kann null sein.

Fehlerantworten