> ## 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 abrufen

> Ein Versand-Heimtest-Kit zum Selbsttesten anhand der ID abrufen

Rufe eine einzelne Heimtest-Kit-Bestellung anhand ihrer UUID ab, einschließlich des eingebetteten Patientenprofils. Nutze diesen Endpunkt, um den Bestellstatus zu prüfen, die Lieferadresse zu überprüfen oder die zugeordneten Panels und Biomarker anzusehen.

Erfordert den Scope `home_kit_orders_view` oder `home_kit_orders_manage`.

## Anfrage

### Pfadparameter

**id** `string` *required*

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

## Antwort

Bei Erfolg gibt die API `200 OK` mit der Heimtest-Kit-Bestellung und dem eingebetteten Profil 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*

Aktueller Status der Heimtest-Kit-Bestellung. Einer der Werte `pending`, `dispatched`, `activated` oder `cancelled`.
Der genaue Fortschritt der Laborergebnisse ergibt sich aus [Ergebnisse abrufen](https://docs.anivahealth.com/de/api/home-kit-orders/get-results.md).

**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 dieser Heimtest-Kit-Bestellung zugeordnete Panel – immer genau eines (ein Heimtest-Kit entspricht 1:1 einem
physischen Kit-Produkt), austauschbar über [Aktualisieren](https://docs.anivahealth.com/de/api/home-kit-orders/update-home-kit.md), solange der Status
`pending` ist. Details zum Panel (Name, Biomarker) findest du über [Panels auflisten](https://docs.anivahealth.com/de/api/panels/list-panels.md).

**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*

Einzel-Biomarker, die dieser Heimtest-Kit-Bestellung außerhalb eines Panels zugeordnet sind. Gleiche jede
`biomarker_id` für Anzeigedaten mit [Biomarker auflisten](https://docs.anivahealth.com/de/api/biomarkers/list-biomarkers.md) und `home_kit=true` ab.

**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*

Sendungen, die mit dieser Heimtest-Kit-Bestellung verknüpft sind, älteste Verknüpfung zuerst – normalerweise das Kit an den Patienten
und die Probe zurück an das Labor. Leer, bis der Versand ein Etikett druckt. Rufe die
vollständigen Sendungsdaten ü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.

## Wiederholte Aufrufe

Aniva speichert die Antwort dieses Endpunkts für jeden API-Schlüssel 60 Minuten lang. Ein wiederholter Aufruf innerhalb
dieser Zeit erhält die gespeicherte Antwort, solange die Heimtest-Kit-Bestellung unverändert bleibt. Nach einer Änderung erhältst du eine aktuelle
Antwort. Die Header `Cache-Status` und `Age` zeigen, dass die Antwort
gespeichert ist und wie alt sie ist.

Um sofort über eine Änderung informiert zu werden, abonniere die Webhook-Events `home_kit_order.created` und das Event des jeweiligen Status, zum Beispiel `home_kit_order.activated`.
Siehe [Wiederholte Abrufe](https://docs.anivahealth.com/de/concepts/webhooks.md#wiederholte-abrufe).

## 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 diesen Vorgang oder die Heimtest-Kit-Bestellung liegt außerhalb deines Berechtigungsbereichs. |
| `404` | Heimtest-Kit-Bestellung nicht gefunden. |
| `500` | Interner Serverfehler. |

```bash cURL theme={null}
curl --request GET \
  --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": "dispatched",
  "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-02T08: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": [
    {
      "biomarker_id": 42,
      "added_at": "2026-04-01T09:52:00Z"
    }
  ],
  "metadata": {},
  "replaces_home_kit_order_id": null,
  "replacement_reason": null,
  "results_ready_emails": [],
  "lab_code": "7642000123",
  "activated_at": null,
  "shipments": [
    { "id": "K2604021FQ7", "added_at": "2026-04-02T08:00:00Z" },
    { "id": "K260402P3XD", "added_at": "2026-04-02T08:00:00Z" }
  ]
}
```

```json 400 theme={null}
{
  "error": "id: Invalid home kit ID format"
}
```

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


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