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

# Zrušit objednávku domácí testovací sady

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

Zruš objednávku domácí testovací sady nastavením jejího stavu na `cancelled`. V odpovědi se vrátí zrušená objednávka domácí testovací sady.

Zrušit lze pouze objednávku ve stavu `pending`. Jakmile má stav `dispatched`, expedice sadu zabalila a opatřila štítkem a zrušení vrátí `409` — stejně jako u objednávky ve stavu `activated`.

Pokud už byla sada objednána u expedice, zrušíme ji nejprve tam a pak tu tvou; volání selže, když ji nevezmou zpět: `409`, když už je sada zabalená a opatřená štítkem, `502`, když expedice zrušení odmítla nebo byla nedostupná. Při jakémkoli selhání **se nic nezmění** — objednávka zůstává platná a `502` můžeš bezpečně zkusit znovu.

Zrušení objednávky, která už má stav `cancelled`, vrátí `200` s touto objednávkou bez ohledu na to, z jakého stavu byla zrušena. Odpověď obsahuje `Idempotent-Replayed: true`, takže rozeznáš opakovaný požadavek od volání, které změnu skutečně provedlo. Viz [Idempotence](https://docs.anivahealth.com/cs/concepts/idempotency.md).

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š zrušit.

## Odpověď

Při úspěchu API vrátí `200 OK` se zrušenou objednávkou domácí testovací sady a jejím vnořeným profilem. Objednávka, která už byla zrušena, vrátí stejné `200`.

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

Stav objednávky domácí testovací sady. Po úspěšném zrušení bude `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 před zrušením — vždy přesně jeden
(domácí testovací sada odpovídá fyzickému produktu sady 1:1). Detaily 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 před zrušením. Údaje pro zobrazení
u každého `biomarker_id` dohledáš 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*

Balíky propojené s touto objednávkou domácí testovací sady před zrušením, od nejstaršího propojení. Kompletní
údaje o balících načteš 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

| Stav | Popis |
| - | - |
| `400` | Neplatný formát ID — zadaná hodnota není platné UUID. |
| `403` | Přístup odepřen — tvůj API klíč nemá přístup k této operaci nebo objednávka domácí testovací sady spadá mimo rozsah tvých oprávnění. |
| `404` | Objednávka domácí testovací sady nenalezena. |
| `409` | Konflikt — objednávka už není ve stavu `pending` (odeslaná nebo aktivovaná), nebo její sadu expedice už zabalila a opatřila štítkem. |
| `500` | Interní chyba serveru. |
| `502` | Expedice odmítla zrušení (obsahuje jejich důvod) nebo byla nedostupná. Nic se nezměnilo; objednávka je stále platná. |

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