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

# Vypsat objednávky domácích testovacích sad

> Načíst domácí testovací sady zasílané poštou dostupné pro tvůj API klíč

Načti seznam objednávek domácích testovacích sad. Objednávka domácí testovací sady zašle poštou sadu pro domácí odběr — Aniva sadu odešle, pacient si doma sám odebere vzorek a pošle ho poštou zpět. Každá objednávka domácí testovací sady obsahuje vložený profil pacienta.

Když je zadané `profile_id`, vrátí všechny objednávky domácích testovacích sad pro daný profil. Když chybí, vrátí všechny dostupné objednávky domácích testovacích sad.

Vyžaduje rozsah `home_kit_orders_view` nebo `home_kit_orders_manage`.

## Požadavek

### Parametry dotazu

**profile\_id** `string`

Filtrovat podle UUID profilu. Když je zadané, vrátí se všechny objednávky domácích testovacích sad pro tento profil.

**lab\_code** `string`

Filtrovat podle laboratorního kódu (přesná shoda) — dohledej k fyzické sadě její objednávku podle kódu,
který je na ní vytištěný, např. před voláním [Aktivovat](https://docs.anivahealth.com/cs/api/home-kit-orders/activate-home-kit.md).

## Odpověď

Při úspěchu API vrátí `200 OK` s polem objektů objednávek domácích testovacích sad.

**id** `string` *required*

Jedinečný identifikátor objednávky domácí testovací sady (UUID).

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

UUID profilu, ke kterému tato objednávka domácí testovací sady patří.

**status** `string` *required*

Aktuální stav objednávky domácí testovací sady. Jedna z hodnot `pending`, `dispatched`, `activated` nebo `cancelled`.
Podrobný stav dokončení laboratorních výsledků zjistíš přes [Získat výsledky](https://docs.anivahealth.com/cs/api/home-kit-orders/get-results.md).

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

Adresa pro doručení sady — jedna ze dvou podob: buď `{ location_id }` s odkazem na známé testovací místo, nebo přímo vložená pole adresy (`name`, `street`, `city`, `postal_code`, `country_code`; nepovinně `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` — stejný slovník jako v locations API). Uveď přesně jednu variantu — odkaz na místo, nebo přímou adresu, ne obojí.

**doručovací adresa**

> [tab] Odkaz na místo
>
> **location\_id** `string` *required*
>
> UUID testovacího místa, kam se sada zasílá.

> [tab] Přímá adresa
>
> **name** `string` *required*
>
> Jméno příjemce, název firmy nebo místa.
>
> **company\_name** `string`
>
> Firma přebírající zásilku za příjemce — strana `c/o` nebo oddělení.
>
> **street** `string` *required*
>
> Název ulice bez čísla domu (např. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Číslo domu (např. `118` nebo `12a`).
>
> **address\_line\_2** `string`
>
> Budova, vchod nebo patro.
>
> **city** `string` *required*
>
> **state** `string`
>
> Stát nebo provincie. Nepovinné.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> Kód ISO 3166-1 alpha-2 (dvě písmena, např. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Laboratorní kód vzorku, pod kterým se hlásí výsledky — je vytištěný na fyzické sadě a pacient
ho přečte z krabičky jako aktivační kód. `null`, dokud není sada zabalená.
Pouze pro čtení.

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

Časové razítko odběru nahlášené přes [Aktivace](https://docs.anivahealth.com/cs/api/home-kit-orders/activate-home-kit.md) — kdy
pacient odebral vzorek. `null`, dokud sada není aktivovaná.

**replaces\_home\_kit\_order\_id** `string`

Objednávka domácí testovací sady, kterou tato nahrazuje, pokud jde o náhradní sadu. `null` u běžné objednávky. Viz
[Vytvoření objednávky domácí testovací sady](https://docs.anivahealth.com/cs/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Důvod odeslání náhradní sady. `null` u běžné objednávky.

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

Adresy malými písmeny, z nichž každá dostane jeden e-mail, jakmile jsou všechny laboratorní výsledky
konečné. Prázdné, když je vypnuto. Viz [E-maily o připravených výsledcích](https://docs.anivahealth.com/cs/concepts/results.md#e-maily-o-pripravenych-vysledcich).

**metadata** `object` *required*

Páry klíč/hodnota definované partnerem, vrácené beze změny. Vždy přítomné — `{}`, pokud nejsou nastaveny.

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

Časové razítko ve formátu ISO 8601, kdy byla objednávka domácí testovací sady vytvořena.

**updated\_at** `string`

Časové razítko ISO 8601 poslední aktualizace. Může být `null`.

**profile** `object` *required*

Profil pacienta spojený s touto objednávkou domácí testovací sady.

**profil**

**id** `string`

Jedinečný identifikátor profilu (UUID).

**handle** `string`

Přezdívka profilu nebo uživatelské jméno. Může být `null`.

**first\_name** `string`

Křestní jméno. Může být `null`.

**last\_name** `string`

Příjmení. Může být `null`.

**email** `string`

E-mailová adresa. Může být `null`.

**phone** `string`

Telefonní číslo ve formátu E.164. Může být `null`.

**sex** `integer`

Biologické pohlaví podle normy ISO/IEC 5218. Může být `null`.

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

Datum narození ve formátu `YYYY-MM-DD`. Může být `null`.

**height** `number`

Výška v centimetrech. Může být `null`.

**weight** `number`

Hmotnost v kilogramech. Může být `null`.

**language** `string`

Preferovaný jazyk: jeden ze 32 kódů ve [Vytvořit profil](https://docs.anivahealth.com/cs/api/profiles/create-profile.md).

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

Zda tento profil přijímá transakční (automatické) e-maily. Může být `null`.

**created\_at** `string`

Časové razítko ISO 8601 vytvoření profilu.

**updated\_at** `string`

Časové razítko ISO 8601 poslední aktualizace profilu. Může být `null`.

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

Panel přiřazený k této objednávce domácí testovací sady — vždy přesně jeden (domácí testovací sada odpovídá 1:1
fyzickému produktu sady), vyměnitelný přes [Upravit](https://docs.anivahealth.com/cs/api/home-kit-orders/update-home-kit.md), dokud je ve stavu
`pending`. Podrobnosti o panelu (název, biomarkery) najdeš přes [Seznam panelů](https://docs.anivahealth.com/cs/api/panels/list-panels.md).

**Pole přiřazení panelu**

**panel\_id** `string`

UUID panelu — dohledáš přes [Seznam panelů](https://docs.anivahealth.com/cs/api/panels/list-panels.md).

**added\_at** `string`

Časové razítko ve formátu ISO 8601, kdy byl panel poprvé přiřazen k této objednávce domácí testovací sady.

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

Samostatné biomarkery přiřazené k této objednávce domácí testovací sady mimo jakýkoli panel. Každé
`biomarker_id` si pro údaje k zobrazení dohledej přes [Seznam biomarkerů](https://docs.anivahealth.com/cs/api/biomarkers/list-biomarkers.md) s `home_kit=true`.

**Pole jednotlivých biomarkerů**

**biomarker\_id** `integer`

Identifikátor biomarkeru — dohledáš přes
[Seznam biomarkerů](https://docs.anivahealth.com/cs/api/biomarkers/list-biomarkers.md) s `home_kit=true`.

**added\_at** `string`

Časové razítko ve formátu ISO 8601, kdy byl biomarker poprvé přiřazen k této objednávce domácí testovací sady.

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

Zásilky propojené s touto objednávkou domácí testovací sady, od nejstaršího propojení — obvykle sada k pacientovi
a vzorek zpět do laboratoře. Prázdné, dokud expedice nevytiskne štítek. Úplné
údaje o zásilkách načti přes [Seznam zásilek](https://docs.anivahealth.com/cs/api/shipments/list-shipments.md) s `?home_kit_order_id=`.

**Pole propojení zásilky**

**id** `string`

Reference zásilky — dohledáš přes [Získání zásilky](https://docs.anivahealth.com/cs/api/shipments/get-shipment.md).

**added\_at** `string`

Časové razítko ve formátu ISO 8601, kdy byla zásilka propojena s touto objednávkou domácí testovací sady.

## Opakovaná volání

Aniva ukládá odpověď tohoto endpointu po dobu 5 minut pro každý API klíč. Opakované volání v tomto
čase dostane uloženou odpověď. Hlavičky `Cache-Status` a `Age` ukazují, že je odpověď
uložená a jak je stará.

Pokud se chceš o změně dozvědět hned, přihlas se k odběru webhook událostí `home_kit_order.created` a událostí pro jednotlivé stavy, například `home_kit_order.activated`.
Viz [Opakované čtení](https://docs.anivahealth.com/cs/concepts/webhooks.md#opakovana-cteni).

## Chybové odpovědi

| Stav | Popis |
| - | - |
| `400` | Chyba validace — například `profile_id` není platné UUID, nebo dotaz obsahuje neznámý parametr. |
| `403` | Zakázáno — tvůj API klíč nemá přístup k této operaci, nebo je požadovaný profil mimo tvůj rozsah oprávnění. |
| `500` | Interní chyba serveru. |

```bash cURL (all home kit orders) theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/home-kit-orders \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (by profile) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/home-kit-orders?profile_id=a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d' \
  --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 403 theme={null}
{
  "error": "Access denied: profile is outside your permission scope"
}
```


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