Zum Hauptinhalt springen
DELETE
Storniere eine Heimtest-Kit-Bestellung, indem du ihren Status auf cancelled setzt. Die stornierte Heimtest-Kit-Bestellung wird in der Antwort zurückgegeben. Nur eine Bestellung mit dem Status pending kann storniert werden. Sobald sie dispatched ist, wurde das Kit vom Fulfillment verpackt und etikettiert, und eine Stornierung gibt 409 zurück – genau wie bei einer Bestellung mit dem Status activated. Wenn das Kit bereits beim Fulfillment bestellt wurde, stornieren wir es dort, bevor wir deine Bestellung stornieren, und der Aufruf schlägt fehl, wenn es dort nicht zurückgenommen wird: 409, wenn das Kit bereits verpackt und etikettiert ist, 502, wenn das Fulfillment die Stornierung abgelehnt hat oder nicht erreichbar war. In jedem Fehlerfall wird nichts geändert – die Bestellung bleibt aktiv, und bei 502 kannst du den Aufruf bedenkenlos wiederholen. Das Stornieren einer Bestellung, die bereits cancelled ist, gibt 200 mit dieser Bestellung zurück, unabhängig davon, aus welchem Status sie storniert wurde. Die Antwort enthält Idempotent-Replayed: true, damit du eine Wiederholung von dem Aufruf unterscheiden kannst, der die Aktion ausgeführt hat. Siehe Idempotenz. Erfordert den Scope home_kit_orders_manage.

Anfrage

Pfadparameter

string
erforderlich
Eindeutige Kennung (UUID) der Heimtest-Kit-Bestellung, die storniert werden soll.

Antwort

Bei Erfolg gibt die API 200 OK mit der stornierten Heimtest-Kit-Bestellung und dem eingebetteten Profil zurück. Eine bereits stornierte Bestellung gibt dasselbe 200 zurück.
string
erforderlich
Eindeutige Kennung (UUID) der Heimtest-Kit-Bestellung.
string
erforderlich
UUID des Profils, zu dem diese Heimtest-Kit-Bestellung gehört.
string
erforderlich
Status der Heimtest-Kit-Bestellung. Ist nach einer erfolgreichen Stornierung cancelled.
object
erforderlich
Die Versandadresse für das Kit – in einer von zwei Formen: entweder { location_id } als Verweis auf einen bekannten Teststandort oder die direkten Adressfelder (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email optional – dieselben Felder wie in der Locations-API). Gib genau eine Variante an – eine Standortreferenz oder eine direkte Adresse, nicht beides.
string
Labor-Probencode, unter dem die Ergebnisse gemeldet werden – auf dem physischen Kit aufgedruckt und der Aktivierungscode, den der Patient von der Box abliest. null, bis das Kit verpackt ist. Schreibgeschützt.
string
erforderlich
Zeitstempel der Probenahme, gemeldet über Aktivieren – wann der Patient seine Probe genommen hat. null, bis das Kit aktiviert ist.
string
Die Heimtest-Kit-Bestellung, die durch diese ersetzt wird, wenn es sich um ein Ersatz-Kit handelt. null bei einer normalen Bestellung. Siehe Heimtest-Kit-Bestellung erstellen.
string
Warum der Ersatz verschickt wurde. null bei einer normalen Bestellung.
string[]
erforderlich
Adressen in Kleinbuchstaben, die jeweils eine E-Mail erhalten, sobald alle Laborergebnisse final sind. Leer, wenn deaktiviert. Siehe E-Mails bei fertigen Ergebnissen.
object
erforderlich
Vom Partner definierte Schlüssel-Wert-Paare, die unverändert zurückgegeben werden. Immer vorhanden – {}, wenn nicht gesetzt.
string
erforderlich
ISO-8601-Zeitstempel, wann die Heimtest-Kit-Bestellung erstellt wurde.
string
ISO-8601-Zeitstempel der letzten Aktualisierung. Kann null sein.
object
erforderlich
Das Patientenprofil, das mit dieser Heimtest-Kit-Bestellung verknüpft ist.
HomeKitOrderPanel[]
erforderlich
Das Panel, das dieser Heimtest-Kit-Bestellung vor der Stornierung zugeordnet war – immer genau eines (ein Heimtest-Kit entspricht 1:1 einem physischen Kit-Produkt). Rufe Panel-Details (Name, Biomarker) über Panels auflisten ab.
HomeKitOrderIndividualBiomarker[]
erforderlich
Frei wählbare Biomarker, die dieser Heimtest-Kit-Bestellung vor der Stornierung zugeordnet waren. Gleiche jede biomarker_id über Biomarker auflisten mit home_kit=true ab, um Anzeigedaten zu erhalten.
HomeKitOrderShipmentLink[]
erforderlich
Pakete, die vor der Stornierung mit dieser Heimtest-Kit-Bestellung verknüpft waren, älteste Verknüpfung zuerst. Rufe die vollständigen Paketdaten über Sendungen auflisten mit ?home_kit_order_id= ab.

Fehlerantworten