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

# Otthoni tesztkészlet-rendelés lemondása

> Mondj le egy postán küldött, otthon elvégezhető tesztkészletet

Mondj le egy otthoni tesztkészlet-rendelést a státusza `cancelled` értékre állításával. A válaszban a lemondott otthoni tesztkészlet-rendelés érkezik vissza.

Csak `pending` státuszú rendelést lehet lemondani. Amint `dispatched` állapotba kerül, a logisztikai partner már becsomagolta és felcímkézte a készletet, így a lemondás `409` hibát ad vissza — ahogy egy `activated` rendelés esetén is.

Ha a készletet már megrendeltük a logisztikai partnertől, előbb náluk mondjuk le, mielőtt a tiédet lemondanánk, és a hívás sikertelen lesz, ha nem veszik vissza: `409`, ha a készletet már becsomagolták és felcímkézték, `502`, ha a logisztikai partner elutasította a lemondást, vagy nem volt elérhető. Minden hiba esetén **semmi sem változik** — a rendelés aktív marad, és az `502` biztonságosan újrapróbálható.

Egy már `cancelled` státuszú rendelés lemondása `200` választ ad vissza az adott rendeléssel, függetlenül attól, milyen státuszból mondták le. A válasz tartalmazza az `Idempotent-Replayed: true` fejlécet, így megkülönböztetheted az ismétlést a tényleges műveletet végrehajtó hívástól. Lásd: [Idempotencia](https://docs.anivahealth.com/hu/concepts/idempotency.md).

Szükséges hozzá a `home_kit_orders_manage` scope.

## Kérés

### Útvonalparaméterek

**id** `string` *required*

A lemondandó otthoni tesztkészlet-rendelés egyedi azonosítója (UUID).

## Válasz

Siker esetén az API `200 OK` választ ad vissza a lemondott otthoni tesztkészlet-rendeléssel és a beágyazott profillal. Egy már korábban lemondott rendelés ugyanazt a `200` választ adja vissza.

**id** `string` *required*

Az otthoni tesztkészlet-rendelés egyedi azonosítója (UUID).

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

Annak a profilnak az UUID-ja, amelyhez ez az otthoni tesztkészlet-rendelés tartozik.

**status** `string` *required*

Az otthoni tesztkészlet-rendelés státusza. Sikeres lemondás után `cancelled` lesz.

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

A cím, ahová a tesztkészletet postázzuk — két formátum egyike: vagy egy `{ location_id }`, amely egy ismert tesztelési helyszínre hivatkozik, vagy a beágyazott címmezők (`name`, `street`, `city`, `postal_code`, `country_code`; a `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` opcionális — ugyanaz a mezőkészlet, mint a helyszínek API-ban). Pontosan az egyiket add meg — vagy helyszínhivatkozást, vagy beágyazott címet, de ne mindkettőt.

**szállítási cím**

> [tab] Helyszínhivatkozás
>
> **location\_id** `string` *required*
>
> Annak a tesztelési helyszínnek az UUID-ja, ahová a készletet szállítjuk.

> [tab] Beágyazott cím
>
> **name** `string` *required*
>
> A címzett, a cég vagy a helyszín neve.
>
> **company\_name** `string`
>
> A csomagot a címzett helyett átvevő cég — `c/o` fél vagy részleg.
>
> **street** `string` *required*
>
> Utcanév házszám nélkül (pl. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Házszám (pl. `118` vagy `12a`).
>
> **address\_line\_2** `string`
>
> Épület, lépcsőház vagy emelet.
>
> **city** `string` *required*
>
> **state** `string`
>
> Állam vagy tartomány. Opcionális.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2 kód (két betű, pl. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

A laboratóriumi mintakód, amely alatt az eredmények beérkeznek — a fizikai készletre van nyomtatva, és ezt
olvassa le a páciens a dobozról aktiválási kódként. `null`, amíg a készletet nem csomagolták be.
Csak olvasható.

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

Az [Aktiválás](https://docs.anivahealth.com/hu/api/home-kit-orders/activate-home-kit.md) végponton keresztül jelentett mintavételi időbélyeg — amikor a
páciens levette a mintát. `null`, amíg a készletet nem aktiválták.

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

Az az otthoni tesztkészlet-rendelés, amelyet ez helyettesít, ha cserekészletről van szó. Normál rendelés esetén `null`. Lásd:
[Otthoni tesztkészlet-rendelés létrehozása](https://docs.anivahealth.com/hu/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

A cserekészlet küldésének oka. Normál rendelés esetén `null`.

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

Címek, amelyek mindegyike egy-egy e-mailt kap, amint minden laboreredmény végleges, kisbetűvel. Kikapcsolva üres. Lásd:
[Eredmények elkészültéről szóló e-mailek](https://docs.anivahealth.com/hu/concepts/results.md#e-mailek-az-elkeszuelt-eredmenyekrol).

**metadata** `object` *required*

A partner által megadott kulcs-érték párok, változatlanul visszaadva. Mindig jelen van — `{}` értékkel, ha nincs megadva.

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

Az otthoni tesztkészlet-rendelés létrehozásának ISO 8601 időbélyege.

**updated\_at** `string`

Az utolsó frissítés ISO 8601 időbélyege. Lehet `null`.

**profile** `object` *required*

Az ehhez az otthoni tesztkészlet-rendeléshez tartozó páciensprofil.

**profil**

**id** `string`

A profil egyedi azonosítója (UUID).

**handle** `string`

Profilazonosító vagy felhasználónév. Lehet `null`.

**first\_name** `string`

Keresztnév. Lehet `null`.

**last\_name** `string`

Vezetéknév. Lehet `null`.

**email** `string`

E-mail-cím. Lehet `null`.

**phone** `string`

Telefonszám E.164 formátumban. Lehet `null`.

**sex** `integer`

Biológiai nem az ISO/IEC 5218 szerint. Lehet `null`.

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

Születési dátum `YYYY-MM-DD` formátumban. Lehet `null`.

**height** `number`

Magasság centiméterben. Lehet `null`.

**weight** `number`

Testsúly kilogrammban. Lehet `null`.

**language** `string`

Preferált nyelv: a [Profil létrehozása](https://docs.anivahealth.com/hu/api/profiles/create-profile.md) pontban szereplő 32 kód egyike.

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

Kap-e ez a profil tranzakciós (programozott) e-maileket. Lehet `null`.

**created\_at** `string`

A profil létrehozásának ISO 8601 időbélyege.

**updated\_at** `string`

A profil utolsó frissítésének ISO 8601 időbélyege. Lehet `null`.

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

A lemondás előtt ehhez az otthoni tesztkészlet-rendeléshez hozzárendelt panel — mindig pontosan egy (egy
otthoni tesztkészlet 1:1 arányban felel meg egy fizikai tesztkészlet-terméknek). A panel részleteit (név, biomarkerek) a
[Panelek listázása](https://docs.anivahealth.com/hu/api/panels/list-panels.md) végponton kérdezheted le.

**Panel-hozzárendelés mezői**

**panel\_id** `string`

A panel UUID-ja — összevethető a [Panelek listázása](https://docs.anivahealth.com/hu/api/panels/list-panels.md) végponttal.

**added\_at** `string`

ISO 8601 időbélyeg arról, amikor a panelt először hozzárendelték ehhez az otthoni tesztkészlet-rendeléshez.

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

Külön választható biomarkerek, amelyeket a lemondás előtt ehhez az otthoni tesztkészlet-rendeléshez rendeltek. A megjelenítési adatokhoz vesd össze
az egyes `biomarker_id` értékeket a [Biomarkerek listázása](https://docs.anivahealth.com/hu/api/biomarkers/list-biomarkers.md) végponttal `home_kit=true` paraméterrel.

**Egyedi biomarker mezői**

**biomarker\_id** `integer`

Biomarker-azonosító — összevethető a
[Biomarkerek listázása](https://docs.anivahealth.com/hu/api/biomarkers/list-biomarkers.md) végponttal `home_kit=true` paraméterrel.

**added\_at** `string`

ISO 8601 időbélyeg arról, amikor a biomarkert először hozzárendelték ehhez az otthoni tesztkészlet-rendeléshez.

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

Csomagok, amelyeket a lemondás előtt ehhez az otthoni tesztkészlet-rendeléshez kapcsoltak, a legrégebbi kapcsolással kezdve. A
teljes csomagadatokat a [Szállítmányok listázása](https://docs.anivahealth.com/hu/api/shipments/list-shipments.md) végponttal és a `?home_kit_order_id=` paraméterrel olvashatod ki.

**Szállítmánykapcsolat mezői**

**id** `string`

Szállítmány-hivatkozás — összevethető a [Szállítmány lekérése](https://docs.anivahealth.com/hu/api/shipments/get-shipment.md) végponttal.

**added\_at** `string`

ISO 8601 időbélyeg arról, amikor a szállítmányt ehhez az otthoni tesztkészlet-rendeléshez kapcsolták.

## Hibaválaszok

| Státusz | Leírás |
| - | - |
| `400` | Érvénytelen azonosítóformátum — a megadott érték nem érvényes UUID. |
| `403` | Tiltott — az API-kulcsodnak nincs hozzáférése ehhez a művelethez, vagy az otthoni tesztkészlet-rendelés kívül esik a jogosultsági körödön. |
| `404` | Az otthoni tesztkészlet-rendelés nem található. |
| `409` | Ütközés — a rendelés már nem `pending` státuszú (feladták vagy aktiválták), vagy a készletet a logisztikai partner már becsomagolta és felcímkézte. |
| `500` | Belső szerverhiba. |
| `502` | A logisztikai partner elutasította a lemondást (tartalmazza az indoklásukat), vagy nem volt elérhető. Semmi sem változott; a rendelés továbbra is aktív. |

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