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

# Annulla ordine di kit domiciliare

> Annulla un kit per test domiciliare fai da te

Annulla un ordine di kit domiciliare impostando il suo stato su `cancelled`. L'ordine di kit domiciliare annullato viene restituito nella risposta.

È possibile annullare solo un ordine `pending`. Una volta che è `dispatched`, il kit è stato imballato ed etichettato dalla logistica e l'annullamento restituisce `409` — così come per un ordine `activated`.

Se il kit è già stato ordinato alla logistica, lo annulliamo lì prima di annullare il tuo, e la chiamata non va a buon fine se non accettano l'annullamento: `409` quando il kit è già imballato ed etichettato, `502` quando la logistica ha rifiutato l'annullamento o non era raggiungibile. In ogni caso di errore **non cambia nulla** — l'ordine rimane attivo e puoi riprovare in sicurezza dopo un `502`.

Annullare un ordine già `cancelled` restituisce `200` con quell'ordine, indipendentemente dallo stato da cui è stato annullato. La risposta include `Idempotent-Replayed: true` così puoi distinguere una ripetizione dalla chiamata che ha eseguito l'operazione. Consulta [Idempotenza](https://docs.anivahealth.com/it/concepts/idempotency.md).

Richiede lo scope `home_kit_orders_manage`.

## Richiesta

### Parametri di percorso

**id** `string` *required*

Identificatore univoco (UUID) dell'ordine di kit domiciliare da annullare.

## Risposta

In caso di successo, l'API restituisce `200 OK` con l'ordine di kit domiciliare annullato e il relativo profilo incorporato. Un ordine già annullato restituisce lo stesso `200`.

**id** `string` *required*

Identificatore univoco dell'ordine di kit domiciliare (UUID).

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

UUID del profilo a cui appartiene questo ordine di kit domiciliare.

**status** `string` *required*

Stato dell'ordine di kit domiciliare. Sarà `cancelled` dopo un annullamento riuscito.

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

L'indirizzo a cui spedire il kit — in uno di due formati: `{ location_id }` che fa riferimento a una sede di test nota, oppure i campi dell'indirizzo inline (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` opzionali — lo stesso vocabolario dell'API delle sedi). Fornisci esattamente uno dei due — un riferimento a una sede o un indirizzo inline, non entrambi.

**indirizzo di consegna**

> [tab] Riferimento sede
>
> **location\_id** `string` *required*
>
> UUID della sede di test a cui viene spedito il kit.

> [tab] Indirizzo inline
>
> **name** `string` *required*
>
> Nome del destinatario, dell'azienda o della sede.
>
> **company\_name** `string`
>
> Azienda che riceve il pacco per conto del destinatario — un destinatario `c/o` o un reparto.
>
> **street** `string` *required*
>
> Nome della via, senza il numero civico (ad es. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Numero civico (ad es. `118` o `12a`).
>
> **address\_line\_2** `string`
>
> Edificio, ingresso o piano.
>
> **city** `string` *required*
>
> **state** `string`
>
> Stato o provincia. Opzionale.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> Codice ISO 3166-1 alpha-2 (due lettere, ad es. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Codice campione di laboratorio con cui vengono refertati i risultati — stampato sul kit fisico e
letto dal paziente sulla scatola come codice di attivazione. `null` finché il kit non viene imballato.
Di sola lettura.

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

Timestamp di raccolta segnalato tramite [Attiva](https://docs.anivahealth.com/it/api/home-kit-orders/activate-home-kit.md) — quando il
paziente ha raccolto il campione. `null` finché il kit non viene attivato.

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

L'ordine di kit domiciliare sostituito da questo, quando si tratta di un kit sostitutivo. `null` su un ordine normale. Consulta
[Crea ordine di kit domiciliare](https://docs.anivahealth.com/it/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Motivo per cui è stata inviata la sostituzione. `null` su un ordine normale.

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

Indirizzi che ricevono ciascuno un'email quando tutti i risultati di laboratorio sono definitivi, in minuscolo. Vuoto se disattivato. Vedi
[Email di risultati pronti](https://docs.anivahealth.com/it/concepts/results.md#email-di-risultati-pronti).

**metadata** `object` *required*

Coppie chiave/valore definite dal partner, restituite esattamente come inviate. Sempre presente — `{}` se non impostato.

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

Timestamp ISO 8601 della creazione dell'ordine di kit domiciliare.

**updated\_at** `string`

Timestamp ISO 8601 dell'ultimo aggiornamento. Può essere `null`.

**profile** `object` *required*

Il profilo del paziente associato a questo ordine di kit domiciliare.

**profilo**

**id** `string`

Identificatore univoco del profilo (UUID).

**handle** `string`

Handle o nome utente del profilo. Può essere `null`.

**first\_name** `string`

Nome. Può essere `null`.

**last\_name** `string`

Cognome. Può essere `null`.

**email** `string`

Indirizzo email. Può essere `null`.

**phone** `string`

Numero di telefono in formato E.164. Può essere `null`.

**sex** `integer`

Sesso biologico secondo ISO/IEC 5218. Può essere `null`.

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

Data di nascita in formato `YYYY-MM-DD`. Può essere `null`.

**height** `number`

Altezza in centimetri. Può essere `null`.

**weight** `number`

Peso in chilogrammi. Può essere `null`.

**language** `string`

Lingua preferita: uno dei 32 codici in [Crea profilo](https://docs.anivahealth.com/it/api/profiles/create-profile.md).

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

Indica se questo profilo riceve email transazionali (programmatiche). Può essere `null`.

**created\_at** `string`

Timestamp ISO 8601 della creazione del profilo.

**updated\_at** `string`

Timestamp ISO 8601 dell'ultimo aggiornamento del profilo. Può essere `null`.

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

Il pannello associato a questo ordine di kit domiciliare prima dell'annullamento — sempre esattamente uno (un
kit domiciliare corrisponde 1:1 a un prodotto kit fisico). Consulta i dettagli del pannello (nome, biomarcatori) tramite
[Elenca pannelli](https://docs.anivahealth.com/it/api/panels/list-panels.md).

**Campi del pannello associato**

**panel\_id** `string`

UUID del pannello — confrontalo con [Elenca pannelli](https://docs.anivahealth.com/it/api/panels/list-panels.md).

**added\_at** `string`

Timestamp ISO 8601 in cui il pannello è stato associato per la prima volta a questo ordine di kit domiciliare.

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

Biomarcatori singoli associati a questo ordine di kit domiciliare prima dell'annullamento. Confronta
ogni `biomarker_id` con [Elenca biomarcatori](https://docs.anivahealth.com/it/api/biomarkers/list-biomarkers.md) con `home_kit=true` per i dati di visualizzazione.

**Campi del biomarcatore singolo**

**biomarker\_id** `integer`

Identificatore del biomarcatore — confrontalo con
[Elenca biomarcatori](https://docs.anivahealth.com/it/api/biomarkers/list-biomarkers.md) con `home_kit=true`.

**added\_at** `string`

Timestamp ISO 8601 in cui il biomarcatore è stato associato per la prima volta a questo ordine di kit domiciliare.

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

Pacchi collegati a questo ordine di kit domiciliare prima dell'annullamento, dal collegamento più vecchio. Leggi i
dettagli completi dei pacchi con [Elenca spedizioni](https://docs.anivahealth.com/it/api/shipments/list-shipments.md) e `?home_kit_order_id=`.

**Campi del collegamento alla spedizione**

**id** `string`

Riferimento della spedizione — confrontalo con [Ottieni spedizione](https://docs.anivahealth.com/it/api/shipments/get-shipment.md).

**added\_at** `string`

Timestamp ISO 8601 in cui la spedizione è stata collegata a questo ordine di kit domiciliare.

## Risposte di errore

| Stato | Descrizione |
| - | - |
| `400` | Formato ID non valido — il valore fornito non è un UUID valido. |
| `403` | Accesso negato — la tua chiave API non ha accesso a questa operazione oppure l'ordine di kit domiciliare è fuori dal tuo ambito di permessi. |
| `404` | Ordine di kit domiciliare non trovato. |
| `409` | Conflitto — l'ordine non è più `pending` (spedito o attivato), oppure il suo kit è già stato imballato ed etichettato dalla logistica. |
| `500` | Errore interno del server. |
| `502` | La logistica ha rifiutato l'annullamento (include il motivo) o non era raggiungibile. Non è cambiato nulla; l'ordine è ancora attivo. |

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