Zum Hauptinhalt springen
DELETE
Storniere einen Versandauftrag. Dabei wird die API des Logistikanbieters aufgerufen, um den Auftrag zu stornieren, und der Sendungsstatus wird auf cancelled aktualisiert. Das Stornieren einer Sendung, die bereits den Status cancelled hat, gibt 200 mit dieser Sendung zurück, und der Anbieter wird nur einmal aufgerufen. Die Antwort enthält Idempotent-Replayed: true, damit du eine Wiederholung von dem Aufruf unterscheiden kannst, der die Aktion ausgeführt hat. Siehe Idempotenz.
Sendungen können nach der Abholung nicht mehr storniert werden – das gibt 409 Conflict zurück.
Ein DHL-Retourenlabel kann nicht einzeln storniert werden; das gibt ebenfalls 409 Conflict zurück. Storniere stattdessen das ausgehende Paket. Beim Stornieren eines ausgehenden DHL-Pakets werden auch seine Rücksende-Einträge mit dem Status pending storniert. Jeder davon erhält den Status cancelled mit einem RETURN_LEG_CANCELLED-Eintrag in status_updates. Siehe Retourenlabels. In einem Karton mit mehreren Kits hat jedes Kit einen eigenen Versand-Eintrag und ein eigenes Retourenlabel, selbst wenn der Karton mit dem Label eines einzelnen Kits verschickt wird. Das Stornieren des Versand-Eintrags eines Kits storniert auch das Retourenlabel dieses Kits. Um ein Home-Kit-Paket zu stornieren, muss jede verknüpfte Home-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).

Antwort

Bei Erfolg gibt die API 200 OK mit dem stornierten Sendungsobjekt zurück.
string
erforderlich
Referenz-ID der Sendung.
string
erforderlich
Status im Sendungslebenszyklus. Ist nach einer erfolgreichen Stornierung 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
Termine, die vor der Stornierung mit dieser Sendung verknüpft waren. Jeder Eintrag hat die Form { id, added_at }; gleiche jede id über Termin abrufen ab. Es werden nur Termine in deinem Zugriffskontext aufgeführt.
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