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

# Anulează comanda de kit de testare la domiciliu

> Anulează un kit de testare la domiciliu trimis prin poștă

Anulează o comandă de kit de testare la domiciliu setându-i statusul la `cancelled`. Comanda de kit de testare la domiciliu anulată este returnată în răspuns.

Doar o comandă `pending` poate fi anulată. Odată ce este `dispatched`, kitul a fost ambalat și etichetat de centrul logistic, iar anularea returnează `409` — la fel ca pentru o comandă `activated`.

Dacă kitul a fost deja comandat la centrul logistic, îl anulăm acolo înainte de a anula comanda ta, iar apelul eșuează când nu îl mai pot opri: `409` când kitul este deja ambalat și etichetat, `502` când centrul logistic a refuzat anularea sau nu a putut fi contactat. În orice caz de eșec, **nu se modifică nimic** — comanda rămâne activă, iar un `502` poate fi reîncercat în siguranță.

Anularea unei comenzi care este deja `cancelled` returnează `200` cu acea comandă, indiferent din ce status a fost anulată. Răspunsul conține `Idempotent-Replayed: true` ca să poți distinge o repetare de apelul care a efectuat operațiunea. Vezi [Idempotență](https://docs.anivahealth.com/ro/concepts/idempotency.md).

Necesită scope-ul `home_kit_orders_manage`.

## Cerere

### Parametri de cale

**id** `string` *required*

Identificatorul unic (UUID) al comenzii de kit de testare la domiciliu de anulat.

## Răspuns

La succes, API-ul returnează `200 OK` cu comanda de kit de testare la domiciliu anulată și profilul integrat al acesteia. O comandă care era deja anulată returnează același `200`.

**id** `string` *required*

Identificatorul unic (UUID) al comenzii de kit de testare la domiciliu.

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

UUID-ul profilului căruia îi aparține această comandă de kit de testare la domiciliu.

**status** `string` *required*

Statusul comenzii de kit de testare la domiciliu. Va fi `cancelled` după o anulare reușită.

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

Adresa la care se trimite kitul — în una dintre două forme: fie `{ location_id }` cu referire la o locație de testare cunoscută, fie câmpurile de adresă inline (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` opționale — același vocabular ca în API-ul de locații). Furnizează exact una dintre ele — o referință de locație sau o adresă inline, nu ambele.

**adresa de livrare**

> [tab] Referință de locație
>
> **location\_id** `string` *required*
>
> UUID-ul locației de testare la care se expediază kitul.

> [tab] Adresă inline
>
> **name** `string` *required*
>
> Numele destinatarului, al companiei sau al locației.
>
> **company\_name** `string`
>
> Compania care păstrează coletul pentru destinatar — o parte `c/o` sau un departament.
>
> **street** `string` *required*
>
> Numele străzii, fără număr (de ex. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Numărul casei (de ex. `118` sau `12a`).
>
> **address\_line\_2** `string`
>
> Clădire, scară sau etaj.
>
> **city** `string` *required*
>
> **state** `string`
>
> Stat sau provincie. Opțional.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> Cod ISO 3166-1 alpha-2 (două litere, de ex. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Codul de probă de laborator sub care sunt raportate rezultatele — tipărit pe kitul fizic, pe care
pacientul îl citește de pe cutie ca cod de activare. `null` până când kitul este ambalat.
Doar citire.

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

Marcajul temporal al recoltării raportat prin [Activează](https://docs.anivahealth.com/ro/api/home-kit-orders/activate-home-kit.md) — momentul în care
pacientul și-a recoltat proba. `null` până când kitul este activat.

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

Comanda de kit de testare la domiciliu pe care o înlocuiește aceasta, când este un kit de înlocuire. `null` pentru o comandă obișnuită. Vezi
[Creează comandă de kit de testare la domiciliu](https://docs.anivahealth.com/ro/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Motivul pentru care a fost trimis kitul de înlocuire. `null` pentru o comandă obișnuită.

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

Adresele care primesc fiecare câte un e-mail când toate rezultatele de laborator sunt finale, cu
litere mici. Gol când este dezactivat. Vezi
[E-mailuri pentru rezultate gata](https://docs.anivahealth.com/ro/concepts/results.md#e-mailuri-cand-rezultatele-sunt-gata).

**metadata** `object` *required*

Perechi cheie/valoare definite de partener, returnate exact așa cum au fost trimise. Întotdeauna prezent — `{}` când nu este setat.

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

Marcajul temporal ISO 8601 al momentului în care a fost creată comanda de kit de testare la domiciliu.

**updated\_at** `string`

Timestamp ISO 8601 al ultimei actualizări. Poate fi `null`.

**profile** `object` *required*

Profilul pacientului asociat acestei comenzi de kit de testare la domiciliu.

**profil**

**id** `string`

Identificatorul unic al profilului (UUID).

**handle** `string`

Handle-ul profilului sau numele de utilizator. Poate fi `null`.

**first\_name** `string`

Prenume. Poate fi `null`.

**last\_name** `string`

Nume de familie. Poate fi `null`.

**email** `string`

Adresă de e-mail. Poate fi `null`.

**phone** `string`

Număr de telefon în format E.164. Poate fi `null`.

**sex** `integer`

Sex biologic conform ISO/IEC 5218. Poate fi `null`.

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

Data nașterii în format `YYYY-MM-DD`. Poate fi `null`.

**height** `number`

Înălțime în centimetri. Poate fi `null`.

**weight** `number`

Greutate în kilograme. Poate fi `null`.

**language** `string`

Limba preferată: unul dintre cele 32 de coduri din [Creează profil](https://docs.anivahealth.com/ro/api/profiles/create-profile.md).

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

Indică dacă acest profil primește e-mailuri tranzacționale (programatice). Poate fi `null`.

**created\_at** `string`

Timestamp ISO 8601 al creării profilului.

**updated\_at** `string`

Timestamp ISO 8601 al ultimei actualizări a profilului. Poate fi `null`.

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

Panelul care era atașat acestei comenzi de kit de testare la domiciliu înainte de anulare — întotdeauna exact unul (un
kit de testare la domiciliu corespunde 1:1 unui produs fizic). Consultă detaliile panelului (nume, biomarkeri) prin
[Listează panelurile](https://docs.anivahealth.com/ro/api/panels/list-panels.md).

**Câmpuri pentru atașarea panelului**

**panel\_id** `string`

UUID-ul panelului — corelează cu [Listează panelurile](https://docs.anivahealth.com/ro/api/panels/list-panels.md).

**added\_at** `string`

Marcajul temporal ISO 8601 al momentului în care panelul a fost atașat prima dată la această comandă de kit de testare la domiciliu.

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

Biomarkeri individuali atașați acestei comenzi de kit de testare la domiciliu înainte de anulare. Corelează
fiecare `biomarker_id` cu [Listează biomarkerii](https://docs.anivahealth.com/ro/api/biomarkers/list-biomarkers.md) cu `home_kit=true` pentru datele de afișare.

**Câmpuri pentru biomarkeri individuali**

**biomarker\_id** `integer`

Identificatorul biomarkerului — corelează cu
[Listează biomarkerii](https://docs.anivahealth.com/ro/api/biomarkers/list-biomarkers.md) cu `home_kit=true`.

**added\_at** `string`

Marcajul temporal ISO 8601 al momentului în care biomarkerul a fost atașat prima dată la această comandă de kit de testare la domiciliu.

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

Colete care erau asociate acestei comenzi de kit de testare la domiciliu înainte de anulare, în ordinea vechimii asocierii. Citește
coletele complete cu [Listează expedierile](https://docs.anivahealth.com/ro/api/shipments/list-shipments.md) și `?home_kit_order_id=`.

**Câmpuri pentru asocierea expedierii**

**id** `string`

Referința expedierii — corelează cu [Obține expedierea](https://docs.anivahealth.com/ro/api/shipments/get-shipment.md).

**added\_at** `string`

Marcajul temporal ISO 8601 al momentului în care expedierea a fost asociată acestei comenzi de kit de testare la domiciliu.

## Răspunsuri de eroare

| Status | Descriere |
| - | - |
| `400` | Format ID invalid — valoarea furnizată nu este un UUID valid. |
| `403` | Interzis — cheia ta API nu are acces la această operațiune sau comanda de kit de testare la domiciliu nu intră în domeniul tău de permisiuni. |
| `404` | Comanda de kit de testare la domiciliu nu a fost găsită. |
| `409` | Conflict — comanda nu mai este `pending` (expediată sau activată) ori kitul ei a fost deja ambalat și etichetat de centrul logistic. |
| `500` | Eroare internă de server. |
| `502` | Centrul logistic a refuzat anularea (include motivul oferit) sau nu a putut fi contactat. Nu s-a modificat nimic; comanda este încă activă. |

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