Zum Hauptinhalt springen
GET
Rufe eine einzelne Sendung anhand ihrer Referenz-ID ab. Die Antwort kommt aus unserer Datenbank und fragt niemals den Versanddienstleister ab. Eine Hintergrund-Synchronisierung aktualisiert jede Sendung (alle 10 Minuten für GO!, stündlich für DHL), und synced_at zeigt dir, wann der Versanddienstleister zuletzt abgefragt wurde. Erfordert den Scope shipments_view oder shipments_manage.

Anfrage

Pfadparameter

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

Antwort

Bei Erfolg gibt die API 200 OK mit dem Sendungsobjekt 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 (z. B. "Medizinisch freigestellte Probe", "Home test kit"). Nur zur Information – ob ein Paket an ein Labor geht, lässt sich an destination ablesen, und das Gegenstück an paired_with. Kann null sein.
string
erforderlich
Wer das Etikett gedruckt hat: aniva oder external. Nur aniva-Sendungen akzeptieren Aktualisieren und Stornieren; ein external-Paket wird verfolgt, gibt aber bei beiden 501 zurück.
string
Referenz des anderen Pakets einer zweiteiligen Sendung – das Paket, das ein Rücksendeetikett enthielt, und das Paket, das mit diesem Etikett zurückkommt. Bei beiden gesetzt. null bei einem Paket ohne Rücksendung.
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 Verlaufsereignisse des Logistikdienstleisters (ältestes zuerst). Leeres Array, wenn der Dienstleister noch keine Ereignisse gemeldet hat. Nutze dies für Ereignis-UI, Audits und detailliertere Signale des Versanddienstleisters; verlass dich für den verbindlichen aktuellen Status auf status.
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, um das vollständige Terminobjekt zu erhalten. Leeres Array, wenn keine Termine verknüpft sind. Es werden nur die Termine in deinem Zugriffskontext aufgelistet.
ShipmentHomeKitOrderLink[]
erforderlich
Mit dieser Sendung verknüpfte Heimtest-Kit-Bestellungen, älteste Verknüpfung zuerst, im gleichen Format { id, added_at }. Gleiche jede id mit Heimtest-Kit-Bestellung abrufen ab. Leeres Array bei Praxispaketen. Es werden nur die Bestellungen in deinem Zugriffskontext aufgelistet. Siehe Zugriff.
string
Wann die Sendung zuletzt mit dem Versanddienstleister abgeglichen wurde, als UTC-Zeitpunkt. Lesezugriffe rufen nie den Versanddienstleister auf – eine Hintergrund-Synchronisierung hält die Sendungen aktuell –, daher zeigt dies, wie alt die Antwort ist. null bis zur ersten Synchronisierung.
string
erforderlich
Erstellungszeitstempel (ISO 8601).
string
Zeitstempel der letzten Aktualisierung (ISO 8601). Kann null sein.

Wiederholte Aufrufe

Aniva speichert die Antwort dieses Endpunkts für 60 Minuten pro API-Schlüssel. Ein wiederholter Aufruf innerhalb dieser Zeit erhält die gespeicherte Antwort, solange die Sendung unverändert ist. Nach einer Änderung bekommst du eine neue Antwort. Die Header Cache-Status und Age zeigen an, dass die Antwort gespeichert ist und wie alt sie ist. In einer gespeicherten Antwort können synced_at und updated_at älter sein als in einer neuen Antwort. Um sofort über eine Änderung informiert zu werden, abonniere die Webhook-Ereignisse shipment.created und shipment.updated. Siehe Wiederholte Lesezugriffe.

Fehlerantworten