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

# Aktualizovat objednávku domácí testovací sady

> Upravit domácí testovací sadu zasílanou poštou

Uprav doručovací adresu, panel, metadata nebo e-maily o připravených výsledcích u objednávky domácí testovací sady. Uveď jen pole, která chceš změnit.

Doručovací adresu a panel můžeš změnit jen ve stavu `pending`, protože fyzická sada odchází při odeslání. Pole `metadata` slouží pro tvou vlastní evidenci a můžeš do něj zapisovat po celou dobu existence objednávky.

Neexistují endpointy pro přidání ani odebrání panelu: domácí testovací sada má vždy přesně jeden panel (odpovídá 1:1 fyzickému produktu sady), takže jediná smysluplná operace s panelem je jeho výměna tady.

Vyžaduje scope `home_kit_orders_manage`.

## Požadavek

### Parametry cesty

**id** `string` *required*

Jedinečný identifikátor (UUID) objednávky domácí testovací sady, kterou chceš upravit.

### Parametry těla

Všechny parametry těla požadavku jsou volitelné — uveď jen pole, která chceš změnit.

**delivery\_address** `object`

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

**doručovací adresa**

> [tab] Odkaz na odběrové místo
>
> **location\_id** `string` *required*
>
> UUID známého odběrového místa, kam se má sada poslat. Spáruj se [Seznamem
> odběrových míst](https://docs.anivahealth.com/cs/api/locations/list-locations.md).

> [tab] Přímá adresa
>
> **name** `string` *required*
>
> Jméno příjemce, název firmy nebo odběrového místa.
>
> **company\_name** `string`
>
> Firma, která zásilku pro příjemce přebírá – kontakt `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. Volitelné.
>
> **postal\_code** `string` *required*
>
> PSČ. Německá adresa (`country_code` `DE`) vyžaduje přesně 5 číslic, např. `10117`.
>
> **country\_code** `string` *required*
>
> Kód ISO 3166-1 alpha-2 (dvě písmena, např. `DE`). Přijímají se i malá písmena a ukládají se
> jako velká.
>
> **phone** `string`
>
> Telefonní číslo příjemce s předvolbou země (např. `+4791234567`). Dopravce ho používá
> k informování příjemce o zásilce, například že čeká na výdejním místě. Když pole vynecháš,
> dopravce žádné telefonní číslo nedostane.
>
> **email** `string`
>
> E-mail příjemce. Dopravce ho používá stejně jako `phone`. Když pole vynecháš, dopravce žádný
> e-mail nedostane.

> [!NOTE]
>
> **Packstation nebo Postfiliale (pouze Německo):** nastav `street` na `Packstation` nebo
> `Postfiliale`, `house_number` na trojmístné číslo stanice a `address_line_2` na DHL Postnummer
> příjemce (6–10 číslic, mezery jsou povoleny). Bez Postnummer nelze zásilku objednat.
> Postfach není podporován.

**panel\_id** `string`

UUID panelu, který nahradí stávající panel – protože každá sada má přesně jeden panel, výměna
je jediná smysluplná operace. Funguje jen ve stavu `pending` a jen pro panel, u kterého má
Aniva nastavený produkt sady k expedici (jinak vrátí `422`); výměna za už přiřazený panel
neprovede žádnou změnu.

**metadata** `object`

Tvoje vlastní páry klíč/hodnota. Do stávajících metadat se **slučují**, místo aby je nahradily:
vynechané klíče zůstanou zachované, klíč odeslaný s hodnotou `null` se smaže a prázdný objekt
`{}` vymaže vše. Limity odpovídají [Vytvoření objednávky domácí testovací sady](https://docs.anivahealth.com/cs/api/home-kit-orders/create-home-kit.md)
a validace platí stylem vše, nebo nic – pokud se zamítne jakýkoli klíč, nezapíše se nic. Nikdy
do `metadata` neukládej osobní ani klinické údaje – nezachází se s nimi jako s údaji pacientů.

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

Nahradí seznam až 5 adres, z nichž každá dostane jeden e-mail, jakmile jsou všechny laboratorní
výsledky finální. Odesláním `[]` e-maily vypneš. Lze upravit v každém stavu kromě `cancelled`.
Tvůj klíč potřebuje přístup `results_view` k danému pacientovi, jinak vrátí `403`. Viz
[E-maily o připravených výsledcích](https://docs.anivahealth.com/cs/concepts/results.md#e-maily-o-pripravenych-vysledcich).

## Odpověď

Při úspěchu API vrátí `200 OK` s upravenou objednávkou domácí testovací sady a jejím vnořeným profilem.

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

**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) a při předání `panel_id` se přímo nahradí. 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.

## Chybové odpovědi

| Status | Popis |
| - | - |
| `400` | Chyba validace – např. neplatný formát UUID nebo chybějící pole v `delivery_address`. |
| `403` | Přístup odepřen – tvůj API klíč nemá oprávnění k této operaci, objednávka domácí testovací sady je mimo rozsah tvých oprávnění, nebo posíláš `results_ready_emails` bez přístupu `results_view` k danému pacientovi. |
| `404` | Objednávka domácí testovací sady nebyla nalezena, nebo panel z `panel_id` neexistuje. |
| `409` | Konflikt – objednávka už není ve stavu `pending`; adresu a panel lze změnit jen před odesláním. |
| `409` | Konflikt – objednávka je náhradní sada, která si zachovává panel z původní objednávky. |
| `409` | Konflikt – objednávka je ve stavu `cancelled` a posíláš `results_ready_emails`. |
| `422` | Panel nelze objednat jako domácí testovací sadu – není pro něj nastavený produkt sady k expedici. |
| `500` | Interní chyba serveru. |

```bash cURL theme={null}
curl --request PATCH \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "delivery_address": {
      "name": "Maria Schmidt",
      "street": "Unter den Linden",
      "house_number": "77",
      "postal_code": "10117",
      "city": "Berlin",
      "country_code": "DE",
      "phone": "+4930123456789",
      "email": "maria.schmidt@example.com"
    }
  }'
```

```json 200 theme={null}
{
  "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "status": "pending",
  "delivery_address": {
    "name": "Maria Schmidt",
    "street": "Unter den Linden",
    "house_number": "77",
    "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-01T13:10: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": { "your_order_ref": "ORD-10482" },
  "replaces_home_kit_order_id": null,
  "replacement_reason": null,
  "results_ready_emails": [],
  "lab_code": null,
  "activated_at": null,
  "shipments": []
}
```

```json 400 theme={null}
{
  "error": "delivery_address: Invalid input"
}
```

```json 409 theme={null}
{
  "error": "Panels and biomarkers can only be changed while the home kit order is pending. Once it is dispatched, activated, or cancelled its composition is locked."
}
```

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