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

# Atcelt mājas testa komplekta pasūtījumu

> Atcelt paštesta komplektu ar piegādi uz mājām

Atcel mājas testa komplekta pasūtījumu, iestatot tā statusu uz `cancelled`. Atceltais mājas testa komplekta pasūtījums tiek atgriezts atbildē.

Atcelt var tikai `pending` statusa pasūtījumu. Tiklīdz tas ir `dispatched` statusā, izpildes centrs komplektu jau ir iepakojis un marķējis, un atcelšana atgriež `409` — tāpat kā `activated` pasūtījumam.

Ja komplekts jau ir pasūtīts izpildes centrā, mēs to vispirms atceļam tur, pirms atceļam tavējo, un izsaukums neizdodas, ja tas to nepieņem atpakaļ: `409`, kad komplekts jau ir iepakots un marķēts, `502`, kad izpildes centrs noraidīja atcelšanu vai nebija sasniedzams. Katrā kļūmes gadījumā **nekas netiek mainīts** — pasūtījums paliek aktīvs, un `502` var droši mēģināt vēlreiz.

Atceļot pasūtījumu, kas jau ir `cancelled` statusā, tiek atgriezts `200` ar šo pasūtījumu neatkarīgi no tā, no kāda statusa tas tika atcelts. Atbilde satur `Idempotent-Replayed: true`, lai tu varētu atšķirt atkārtojumu no izsaukuma, kas veica darbību. Skati [Idempotence](https://docs.anivahealth.com/lv/concepts/idempotency.md).

Nepieciešams `home_kit_orders_manage` tvērums.

## Pieprasījums

### Ceļa parametri

**id** `string` *required*

Atceļamā mājas testa komplekta pasūtījuma unikālais identifikators (UUID).

## Atbilde

Veiksmīgas izpildes gadījumā API atgriež `200 OK` ar atcelto mājas testa komplekta pasūtījumu un tajā iekļauto profilu. Jau atcelts pasūtījums atgriež to pašu `200`.

**id** `string` *required*

Unikālais mājas testa komplekta pasūtījuma identifikators (UUID).

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

Tā profila UUID, kuram pieder šis mājas testa komplekta pasūtījums.

**status** `string` *required*

Mājas testa komplekta pasūtījuma statuss. Pēc veiksmīgas atcelšanas būs `cancelled`.

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

Adrese, uz kuru nosūtīt komplektu — vienā no divām formām: vai nu `{ location_id }`, kas atsaucas uz zināmu testēšanas vietu, vai tiešās adreses lauki (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` nav obligāti — tie paši lauki kā atrašanās vietu API). Norādi tieši vienu — atsauci uz vietu vai tiešo adresi, ne abas.

**piegādes adrese**

> [tab] Atsauce uz vietu
>
> **location\_id** `string` *required*
>
> Tās testēšanas vietas UUID, uz kuru tiek nosūtīts komplekts.

> [tab] Tiešā adrese
>
> **name** `string` *required*
>
> Saņēmēja, uzņēmuma vai vietas nosaukums.
>
> **company\_name** `string`
>
> Uzņēmums, kas pieņem sūtījumu saņēmēja vietā — `c/o` puse vai nodaļa.
>
> **street** `string` *required*
>
> Ielas nosaukums bez mājas numura (piem., `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Mājas numurs (piem., `118` vai `12a`).
>
> **address\_line\_2** `string`
>
> Ēka, ieeja vai stāvs.
>
> **city** `string` *required*
>
> **state** `string`
>
> Štats vai province. Nav obligāts.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2 kods (divi burti, piem., `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Laboratorijas parauga kods, zem kura tiek ziņoti rezultāti — uzdrukāts uz fiziskā komplekta, un tas ir kods, ko
pacients nolasa no kastītes kā aktivizācijas kodu. `null`, līdz komplekts ir iepakots.
Tikai lasīšanai.

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

Parauga paņemšanas laikspiedols, kas ziņots ar [Aktivizēt](https://docs.anivahealth.com/lv/api/home-kit-orders/activate-home-kit.md) — kad
pacients paņēma paraugu. `null`, līdz komplekts ir aktivizēts.

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

Mājas testa komplekta pasūtījums, ko šis aizstāj, ja tas ir aizstāšanas komplekts. `null` parastam pasūtījumam. Skati
[Izveidot mājas testa komplekta pasūtījumu](https://docs.anivahealth.com/lv/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Kāpēc tika nosūtīts aizstāšanas komplekts. `null` parastam pasūtījumam.

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

Adreses mazajiem burtiem, no kurām katra saņem vienu e-pastu, tiklīdz visi laboratorijas rezultāti ir galīgi. Tukšs, kad izslēgts. Skatīt
[E-pasti par gataviem rezultātiem](https://docs.anivahealth.com/lv/concepts/results.md#e-pasti-par-gataviem-rezultatiem).

**metadata** `object` *required*

Partnera definēti atslēgu un vērtību pāri, kas tiek atgriezti nemainītā veidā. Vienmēr norādīts — `{}`, ja nav iestatīts.

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

ISO 8601 laikspiedols, kad tika izveidots mājas testa komplekta pasūtījums.

**updated\_at** `string`

Pēdējā atjauninājuma ISO 8601 laikspiedols. Var būt `null`.

**profile** `object` *required*

Pacienta profils, kas saistīts ar šo mājas testa komplekta pasūtījumu.

**profils**

**id** `string`

Unikāls profila identifikators (UUID).

**handle** `string`

Profila segvārds vai lietotājvārds. Var būt `null`.

**first\_name** `string`

Vārds. Var būt `null`.

**last\_name** `string`

Uzvārds. Var būt `null`.

**email** `string`

E-pasta adrese. Var būt `null`.

**phone** `string`

Tālruņa numurs E.164 formātā. Var būt `null`.

**sex** `integer`

Bioloģiskais dzimums saskaņā ar ISO/IEC 5218. Var būt `null`.

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

Dzimšanas datums formātā `YYYY-MM-DD`. Var būt `null`.

**height** `number`

Augums centimetros. Var būt `null`.

**weight** `number`

Svars kilogramos. Var būt `null`.

**language** `string`

Vēlamā valoda: viens no 32 kodiem sadaļā [Izveidot profilu](https://docs.anivahealth.com/lv/api/profiles/create-profile.md).

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

Vai šis profils saņem darījumu (programmatiskos) e-pastus. Var būt `null`.

**created\_at** `string`

ISO 8601 laikspiedols, kad profils tika izveidots.

**updated\_at** `string`

Pēdējā profila atjauninājuma ISO 8601 laikspiedols. Var būt `null`.

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

Panelis, kas bija pievienots šim mājas testa komplekta pasūtījumam pirms atcelšanas — vienmēr tieši viens (viens
mājas testa komplekts attiecībā 1:1 atbilst fiziskam komplekta produktam). Meklē paneļa datus (nosaukumu, biomarķierus) ar
[Uzskaitīt paneļus](https://docs.anivahealth.com/lv/api/panels/list-panels.md).

**Paneļa pievienošanas lauki**

**panel\_id** `string`

Paneļa UUID — salīdzini ar [Uzskaitīt paneļus](https://docs.anivahealth.com/lv/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601 laikspiedols, kad panelis pirmo reizi tika pievienots šim mājas testa komplekta pasūtījumam.

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

Atsevišķi izvēlētie biomarķieri, kas bija pievienoti šim mājas testa komplekta pasūtījumam pirms atcelšanas. Salīdzini
katru `biomarker_id` ar [Uzskaitīt biomarķierus](https://docs.anivahealth.com/lv/api/biomarkers/list-biomarkers.md) ar `home_kit=true`, lai iegūtu attēlošanas datus.

**Atsevišķa biomarķiera lauki**

**biomarker\_id** `integer`

Biomarķiera identifikators — salīdzini ar
[Uzskaitīt biomarķierus](https://docs.anivahealth.com/lv/api/biomarkers/list-biomarkers.md) ar `home_kit=true`.

**added\_at** `string`

ISO 8601 laikspiedols, kad biomarķieris pirmo reizi tika pievienots šim mājas testa komplekta pasūtījumam.

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

Sūtījumi, kas bija piesaistīti šim mājas testa komplekta pasūtījumam pirms atcelšanas, sākot ar vecāko saiti. Nolasi
pilnus sūtījumus ar [Uzskaitīt sūtījumus](https://docs.anivahealth.com/lv/api/shipments/list-shipments.md) un `?home_kit_order_id=`.

**Sūtījuma saites lauki**

**id** `string`

Sūtījuma atsauce — salīdzini ar [Iegūt sūtījumu](https://docs.anivahealth.com/lv/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601 laikspiedols, kad sūtījums tika piesaistīts šim mājas testa komplekta pasūtījumam.

## Kļūdu atbildes

| Statuss | Apraksts |
| - | - |
| `400` | Nederīgs ID formāts — norādītā vērtība nav derīgs UUID. |
| `403` | Aizliegts — tavai API atslēgai nav piekļuves šai darbībai vai mājas testa komplekta pasūtījums ir ārpus tava atļauju tvēruma. |
| `404` | Mājas testa komplekta pasūtījums nav atrasts. |
| `409` | Konflikts — pasūtījums vairs nav `pending` statusā (nosūtīts vai aktivizēts), vai izpildes centrs tā komplektu jau ir iepakojis un marķējis. |
| `500` | Iekšēja servera kļūda. |
| `502` | Izpildes centrs noraidīja atcelšanu (ietver tā iemeslu) vai nebija sasniedzams. Nekas netika mainīts; pasūtījums joprojām ir aktīvs. |

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