Zum Hauptinhalt springen
POST
Erstelle einen Versandauftrag vom angegebenen Absendestandort. Mit destination_lab gibst du das Ziellabor an. Die Sendung geht an die für dieses Labor hinterlegte Versandadresse. Erfordert den Scope shipments_manage. Sende einen optionalen Idempotency-Key-Header, damit sich das Erstellen sicher wiederholen lässt – bei Wiederholung mit demselben Schlüssel kommt die ursprüngliche Antwort zurück, statt einen zweiten Termin zu erstellen. Siehe Idempotenz.

Anfrage

Body-Parameter

string
erforderlich
UUID des Absende-Teststandorts. Der Standort muss aktiv sein und im Zugriffskontext deines API-Keys liegen. Nutze Standorte auflisten, um verfügbare Standort-IDs zu finden.
string
erforderlich
Ziellabor. Einer der Werte zotzklimas, labclinic, nordicgroup, biomes, imd oder quade. Die Sendung geht an die für dieses Labor hinterlegte Versandadresse. Bei einem Labor ohne hinterlegte Versandadresse wird 400 zurückgegeben.
string
Optionale Termin-UUID, um diese Sendung bei der Erstellung mit einem Termin zu verknüpfen. Der Termin muss im Zugriffskontext deines API-Keys liegen. Die Verknüpfung erscheint direkt als Eintrag im appointments-Array der Sendung und umgekehrt als Eintrag im shipments-Array des Termins. Um nach der Erstellung weitere Termine zu verknüpfen oder die ursprüngliche Verknüpfung zu entfernen, nutze Termine mit Sendung verknüpfen und Termine von Sendung lösen.
string
erforderlich
Abholdatum im Format YYYY-MM-DD (z. B. 2026-04-15), interpretiert in der Zeitzone des Absendestandorts. Muss ein Wochentag (Montag–Freitag) sein, heute oder in der Zukunft. Abholungen am selben Tag sind nach 16:00 Uhr (Europe/Berlin) nicht möglich.
string
erforderlich
Früheste Abholzeit im Format HH:MM (z. B. 09:00), interpretiert als Ortszeit in der Zeitzone des Absendestandorts. Muss zwischen 09:00 und 19:00 liegen.
string
erforderlich
Späteste Abholzeit im Format HH:MM (z. B. 12:00), interpretiert als Ortszeit in der Zeitzone des Absendestandorts. Muss zwischen 09:00 und 19:00 liegen. Das Zeitfenster (pickup_time_till - pickup_time_from) muss mindestens 2 Stunden betragen.
integer
Standard:"1"
Anzahl der Pakete. Standardwert ist 1.
number
Standard:"0.5"
Gewicht in kg. Standardwert ist 0.5.
string
Hinweise für den Kurier bei der Abholung (Absenderhinweise). Wenn nicht angegeben, werden die für die Abholadresse hinterlegten Hinweise verwendet (oder keine, falls dort keine hinterlegt sind). Maximal 128 Zeichen.
string
Freitextbeschreibung des Paketinhalts, die dem Kurier angezeigt und als contents zurückgegeben wird. Maximal 40 Zeichen (z. B. Medizinisch freigestellte Probe).
string
Optionale interne Notizen. Maximal 128 Zeichen.

Antwort

Bei Erfolg gibt die API 201 Created mit der neuen Sendung zurück.
string
erforderlich
Referenz-ID der Sendung (z. B. P2604151234).
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 Etikett gedruckt hat: aniva oder external. Eine von dir erstellte Sendung ist aniva.
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. Direkt nach der Erstellung ein leeres Array. Die Hintergrund-Synchronisierung fügt Ereignisse hinzu, sobald der Anbieter sie meldet.
ShipmentAppointmentLink[]
erforderlich
Termine, die mit dieser Sendung verknüpft sind (älteste Verknüpfung zuerst). Jeder Eintrag hat die Form { id, added_at }; gleiche jede id über Termin abrufen ab. Enthält direkt nach der Erstellung den über appointment_id übergebenen Termin (falls angegeben).
ShipmentHomeKitOrderLink[]
erforderlich
Home-Kit-Bestellungen, die mit dieser Sendung verknüpft sind, in derselben Form { id, added_at }. Leeres Array bei einer von dir erstellten Sendung.
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