> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Heimtest-Kit-Bestellung stornieren

> Ein Versand-Heimtest-Kit zum Selbsttesten stornieren

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](https://docs.anivahealth.com/de/concepts/idempotency.md).

Erfordert den Scope `home_kit_orders_manage`.

## Anfrage

### Pfadparameter

**id** `string` *required*

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.

**id** `string` *required*

Eindeutige Kennung (UUID) der Heimtest-Kit-Bestellung.

**profile\_id** `string` *required*

UUID des Profils, zu dem diese Heimtest-Kit-Bestellung gehört.

**status** `string` *required*

Status der Heimtest-Kit-Bestellung. Ist nach einer erfolgreichen Stornierung `cancelled`.

**delivery\_address** `object` *required*

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.

**Lieferadresse**

> [tab] Standortreferenz
>
> **location\_id** `string` *required*
>
> UUID des Teststandorts, an den das Kit verschickt wird.

> [tab] Direkte Adresse
>
> **name** `string` *required*
>
> Name des Empfängers, des Unternehmens oder des Standorts.
>
> **company\_name** `string`
>
> Unternehmen, das das Paket für den Empfänger annimmt – ein `c/o`-Empfänger oder eine Abteilung.
>
> **street** `string` *required*
>
> Straßenname ohne Hausnummer (z. B. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Hausnummer (z. B. `118` oder `12a`).
>
> **address\_line\_2** `string`
>
> Gebäude, Eingang oder Etage.
>
> **city** `string` *required*
>
> **state** `string`
>
> Bundesland oder Provinz. Optional.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> Code nach ISO 3166-1 alpha-2 (zwei Buchstaben, z. B. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `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.

**activated\_at** `string` *required*

Zeitstempel der Probenahme, gemeldet über [Aktivieren](https://docs.anivahealth.com/de/api/home-kit-orders/activate-home-kit.md) – wann der
Patient seine Probe genommen hat. `null`, bis das Kit aktiviert ist.

**replaces\_home\_kit\_order\_id** `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](https://docs.anivahealth.com/de/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Warum der Ersatz verschickt wurde. `null` bei einer normalen Bestellung.

**results\_ready\_emails** `string[]` *required*

Adressen in Kleinbuchstaben, die jeweils eine E-Mail erhalten, sobald alle Laborergebnisse final sind. Leer, wenn deaktiviert. Siehe
[E-Mails bei fertigen Ergebnissen](https://docs.anivahealth.com/de/concepts/results.md#e-mails-bei-fertigen-ergebnissen).

**metadata** `object` *required*

Vom Partner definierte Schlüssel-Wert-Paare, die unverändert zurückgegeben werden. Immer vorhanden – `{}`, wenn nicht gesetzt.

**created\_at** `string` *required*

ISO-8601-Zeitstempel, wann die Heimtest-Kit-Bestellung erstellt wurde.

**updated\_at** `string`

ISO-8601-Zeitstempel der letzten Aktualisierung. Kann `null` sein.

**profile** `object` *required*

Das Patientenprofil, das mit dieser Heimtest-Kit-Bestellung verknüpft ist.

**Profil**

**id** `string`

Eindeutige Profilkennung (UUID).

**handle** `string`

Profil-Handle oder Benutzername. Kann `null` sein.

**first\_name** `string`

Vorname. Kann `null` sein.

**last\_name** `string`

Nachname. Kann `null` sein.

**email** `string`

E-Mail-Adresse. Kann `null` sein.

**phone** `string`

Telefonnummer im E.164-Format. Kann `null` sein.

**sex** `integer`

Biologisches Geschlecht nach ISO/IEC 5218. Kann `null` sein.

**date\_of\_birth** `string`

Geburtsdatum im Format `YYYY-MM-DD`. Kann `null` sein.

**height** `number`

Körpergröße in Zentimetern. Kann `null` sein.

**weight** `number`

Gewicht in Kilogramm. Kann `null` sein.

**language** `string`

Bevorzugte Sprache: einer der 32 Codes unter [Profil erstellen](https://docs.anivahealth.com/de/api/profiles/create-profile.md).

**transactional\_emails\_enabled** `boolean`

Ob dieses Profil transaktionale (programmatische) E-Mails erhält. Kann `null` sein.

**created\_at** `string`

ISO-8601-Zeitstempel der Erstellung des Profils.

**updated\_at** `string`

ISO-8601-Zeitstempel der letzten Profilaktualisierung. Kann `null` sein.

**panels** `HomeKitOrderPanel[]` *required*

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](https://docs.anivahealth.com/de/api/panels/list-panels.md) ab.

**Felder der Panel-Zuordnung**

**panel\_id** `string`

Panel-UUID – zum Abgleich mit [Panels auflisten](https://docs.anivahealth.com/de/api/panels/list-panels.md).

**added\_at** `string`

ISO-8601-Zeitstempel, wann das Panel dieser Heimtest-Kit-Bestellung erstmals zugeordnet wurde.

**individual\_biomarkers** `HomeKitOrderIndividualBiomarker[]` *required*

Frei wählbare Biomarker, die dieser Heimtest-Kit-Bestellung vor der Stornierung zugeordnet waren. Gleiche
jede `biomarker_id` über [Biomarker auflisten](https://docs.anivahealth.com/de/api/biomarkers/list-biomarkers.md) mit `home_kit=true` ab, um Anzeigedaten zu erhalten.

**Felder einzelner Biomarker**

**biomarker\_id** `integer`

Biomarker-ID – zum Abgleich mit
[Biomarker auflisten](https://docs.anivahealth.com/de/api/biomarkers/list-biomarkers.md) mit `home_kit=true`.

**added\_at** `string`

ISO-8601-Zeitstempel, wann der Biomarker dieser Heimtest-Kit-Bestellung erstmals zugeordnet wurde.

**shipments** `HomeKitOrderShipmentLink[]` *required*

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](https://docs.anivahealth.com/de/api/shipments/list-shipments.md) mit `?home_kit_order_id=` ab.

**Felder der Sendungsverknüpfung**

**id** `string`

Sendungsreferenz – zum Abgleich mit [Sendung abrufen](https://docs.anivahealth.com/de/api/shipments/get-shipment.md).

**added\_at** `string`

ISO-8601-Zeitstempel, wann die Sendung mit dieser Heimtest-Kit-Bestellung verknüpft wurde.

## Fehlerantworten

| Status | Beschreibung |
| - | - |
| `400` | Ungültiges ID-Format – der angegebene Wert ist keine gültige UUID. |
| `403` | Zugriff verweigert – dein API-Schlüssel hat keinen Zugriff auf diese Operation oder die Heimtest-Kit-Bestellung liegt außerhalb deines Berechtigungsbereichs. |
| `404` | Heimtest-Kit-Bestellung nicht gefunden. |
| `409` | Konflikt – die Bestellung hat nicht mehr den Status `pending` (versendet oder aktiviert), oder das Kit wurde bereits vom Fulfillment verpackt und etikettiert. |
| `500` | Interner Serverfehler. |
| `502` | Das Fulfillment hat die Stornierung abgelehnt (enthält den Grund) oder war nicht erreichbar. Es wurde nichts geändert; die Bestellung ist weiterhin aktiv. |

```bash cURL theme={null}
curl --request DELETE \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "status": "cancelled",
  "delivery_address": {
    "name": "Maria Schmidt",
    "street": "Friedrichstraße",
    "house_number": "123",
    "postal_code": "10117",
    "city": "Berlin",
    "country_code": "DE",
    "phone": "+4930123456789",
    "email": "maria.schmidt@example.com"
  },
  "created_at": "2026-04-01T09:45:00Z",
  "updated_at": "2026-04-03T10:00:00Z",
  "profile": {
    "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "handle": null,
    "first_name": "Maria",
    "last_name": "Schmidt",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "height": 168,
    "weight": 65,
    "language": "de",
    "transactional_emails_enabled": true,
    "created_at": "2026-04-01T09:14:32Z",
    "updated_at": null
  },
  "panels": [
    {
      "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
      "added_at": "2026-04-01T09:50:00Z"
    }
  ],
  "individual_biomarkers": [],
  "metadata": {},
  "replaces_home_kit_order_id": null,
  "replacement_reason": null,
  "results_ready_emails": [],
  "lab_code": null,
  "activated_at": null,
  "shipments": []
}
```

```json 404 theme={null}
{
  "error": "Home kit order not found"
}
```

```json 409 theme={null}
{
  "error": "A home kit order can only be cancelled while it is pending. Once it is dispatched or activated the physical kit has been packed and labelled and can no longer be called back."
}
```

```json 502 theme={null}
{
  "error": "Fulfilment refused the cancellation (Order is already in fulfillment). The home kit order was NOT cancelled."
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.