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

# Mettre à jour une commande de kit à domicile

> Modifier un kit d'autotest envoyé à domicile

Mets à jour l'adresse de livraison, le panel, les métadonnées ou les e-mails de résultats prêts d'une commande de kit à domicile. N'inclus que les champs que tu veux modifier.

L'adresse de livraison et le panel ne peuvent être modifiés que lorsque la commande est `pending`, car le kit physique part à l'expédition. `metadata` correspond à ton propre suivi interne et reste modifiable pendant toute la durée de vie de la commande.

Il n'y a pas d'endpoints pour ajouter ou retirer un panel : un kit à domicile contient exactement un panel (il correspond en 1:1 à un kit physique), donc la seule opération pertinente sur le panel est le remplacement que tu fais ici.

Requiert le scope `home_kit_orders_manage`.

## Requête

### Paramètres de chemin

**id** `string` *required*

Identifiant unique (UUID) de la commande de kit à domicile à mettre à jour.

### Paramètres du corps

Tous les paramètres du corps sont facultatifs — inclus uniquement les champs que tu veux modifier.

**delivery\_address** `object`

L'adresse à laquelle envoyer le kit — deux formats possibles : soit `{ location_id }` en référence à un lieu de test connu, soit les champs d'adresse intégrés (`name`, `street`, `city`, `postal_code`, `country_code` ; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` facultatifs — le même vocabulaire que l'API des lieux). Fournis exactement l'un des deux — une référence de lieu ou une adresse intégrée, pas les deux.

**adresse de livraison**

> [tab] Référencer un lieu
>
> **location\_id** `string` *required*
>
> UUID d'un lieu de test connu où expédier le kit. À mettre en correspondance avec [Lister
> les lieux](https://docs.anivahealth.com/fr/api/locations/list-locations.md).

> [tab] Adresse intégrée
>
> **name** `string` *required*
>
> Nom du destinataire, de l'entreprise ou du lieu.
>
> **company\_name** `string`
>
> Entreprise qui réceptionne le colis pour le destinataire — un tiers `c/o` ou un service.
>
> **street** `string` *required*
>
> Nom de la rue, sans le numéro (par ex. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Numéro de rue (par ex. `118` ou `12a`).
>
> **address\_line\_2** `string`
>
> Bâtiment, entrée ou étage.
>
> **city** `string` *required*
>
> **state** `string`
>
> État ou province. Facultatif.
>
> **postal\_code** `string` *required*
>
> Code postal. Une adresse allemande (`country_code` `DE`) doit comporter exactement 5 chiffres, par ex. `10117`.
>
> **country\_code** `string` *required*
>
> Code ISO 3166-1 alpha-2 (deux lettres, par ex. `DE`). Les minuscules sont acceptées et stockées en
> majuscules.
>
> **phone** `string`
>
> Numéro de téléphone du destinataire, avec l'indicatif pays (par ex. `+4791234567`). Le transporteur l'utilise pour
> informer le destinataire au sujet du colis, par exemple qu'il l'attend en point relais. Ne le renseigne
> pas et le transporteur ne reçoit aucun numéro de téléphone.
>
> **email** `string`
>
> E-mail du destinataire. Le transporteur l'utilise comme `phone`. Ne le renseigne pas et le transporteur ne reçoit aucun
> e-mail.

> [!NOTE]
>
> **Packstation ou Postfiliale (Allemagne uniquement) :** définis `street` sur `Packstation` ou `Postfiliale`,
> `house_number` sur le numéro de station à trois chiffres, et `address_line_2` sur le DHL
> Postnummer du destinataire (6 à 10 chiffres, espaces autorisés). Sans le Postnummer, le colis ne peut pas être enregistré.
> Un Postfach n'est pas pris en charge.

**panel\_id** `string`

UUID du panel à associer à la place du panel actuel — avec exactement un panel par kit, un
remplacement est la seule opération pertinente. Uniquement lorsque la commande est `pending`, et
uniquement vers un panel qu'Aniva a configuré avec un produit de kit d'expédition (`422` sinon) ;
un remplacement par le panel déjà associé est sans effet.

**metadata** `object`

Tes propres paires clé/valeur. **Fusionnées** avec les métadonnées existantes plutôt que de les
remplacer : les clés que tu omets sont conservées, une clé envoyée avec la valeur `null` est
supprimée, et un objet vide `{}` efface tout. Les limites sont les mêmes que pour [Créer une
commande de kit à domicile](https://docs.anivahealth.com/fr/api/home-kit-orders/create-home-kit.md), et la validation est
tout-ou-rien — si une clé est rejetée, rien n'est enregistré. Ne mets jamais de données
personnelles ou cliniques dans `metadata` — elles ne sont pas traitées comme des données patient.

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

Remplace la liste de 5 adresses maximum qui reçoivent chacune un e-mail dès que tous les résultats
de laboratoire sont définitifs. Envoie `[]` pour désactiver les e-mails. Modifiable dans tous les
statuts sauf `cancelled`. Ta clé a besoin de l'accès `results_view` pour le patient, sinon `403`.
Voir [E-mails de résultats prêts](https://docs.anivahealth.com/fr/concepts/results.md#e-mails-de-resultats-prets).

## Réponse

En cas de succès, l'API renvoie `200 OK` avec la commande de kit à domicile mise à jour et son profil intégré.

**id** `string` *required*

Identifiant unique de la commande de kit à domicile (UUID).

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

UUID du profil auquel appartient cette commande de kit à domicile.

**status** `string` *required*

Statut actuel de la commande de kit à domicile. L'une des valeurs `pending`, `dispatched`, `activated` ou `cancelled`.

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

L'adresse à laquelle envoyer le kit — deux formats possibles : soit `{ location_id }` faisant référence à un lieu de test connu, soit les champs d'adresse directe (`name`, `street`, `city`, `postal_code`, `country_code` ; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` facultatifs — le même vocabulaire que l'API des lieux). Indique exactement un format — une référence de lieu ou une adresse directe, pas les deux.

**adresse de livraison**

> [tab] Référence de lieu
>
> **location\_id** `string` *required*
>
> UUID du lieu de test auquel le kit est expédié.

> [tab] Adresse directe
>
> **name** `string` *required*
>
> Nom du destinataire, de l'entreprise ou du lieu.
>
> **company\_name** `string`
>
> Entreprise qui réceptionne le colis pour le destinataire — un tiers `c/o` ou un service.
>
> **street** `string` *required*
>
> Nom de la rue, sans le numéro (par ex. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Numéro de rue (par ex. `118` ou `12a`).
>
> **address\_line\_2** `string`
>
> Bâtiment, entrée ou étage.
>
> **city** `string` *required*
>
> **state** `string`
>
> État ou province. Facultatif.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> Code ISO 3166-1 alpha-2 (deux lettres, par ex. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Code d'échantillon de laboratoire sous lequel les résultats sont enregistrés — imprimé sur le kit physique, et que le
patient lit sur la boîte comme code d'activation. `null` tant que le kit n'est pas emballé.
En lecture seule.

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

Horodatage du prélèvement transmis via [Activer](https://docs.anivahealth.com/fr/api/home-kit-orders/activate-home-kit.md) — moment auquel le
patient a effectué son prélèvement. `null` tant que le kit n'est pas activé.

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

La commande de kit à domicile que celle-ci remplace, lorsqu'il s'agit d'un kit de remplacement. `null` pour une commande normale. Voir
[Créer une commande de kit à domicile](https://docs.anivahealth.com/fr/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Motif de l'envoi du kit de remplacement. `null` pour une commande normale.

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

Adresses en minuscules qui reçoivent chacune un e-mail une fois tous les résultats de laboratoire
définitifs. Vide si désactivé. Voir [E-mails de résultats prêts](https://docs.anivahealth.com/fr/concepts/results.md#e-mails-de-resultats-prets).

**metadata** `object` *required*

Paires clé/valeur définies par le partenaire, renvoyées telles quelles. Toujours présent — `{}` lorsqu'aucune valeur n'est définie.

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

Horodatage ISO 8601 de la création de la commande de kit à domicile.

**updated\_at** `string`

Horodatage ISO 8601 de la dernière mise à jour. Peut être `null`.

**profile** `object` *required*

Le profil patient associé à cette commande de kit à domicile.

**Profil**

**id** `string`

Identifiant unique du profil (UUID).

**handle** `string`

Pseudonyme ou nom d'utilisateur du profil. Peut être `null`.

**first\_name** `string`

Prénom. Peut être `null`.

**last\_name** `string`

Nom de famille. Peut être `null`.

**email** `string`

Adresse e-mail. Peut être `null`.

**phone** `string`

Numéro de téléphone au format E.164. Peut être `null`.

**sex** `integer`

Sexe biologique selon la norme ISO/IEC 5218. Peut être `null`.

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

Date de naissance au format `YYYY-MM-DD`. Peut être `null`.

**height** `number`

Taille en centimètres. Peut être `null`.

**weight** `number`

Poids en kilogrammes. Peut être `null`.

**language** `string`

Langue préférée : l'un des 32 codes listés dans [Créer un profil](https://docs.anivahealth.com/fr/api/profiles/create-profile.md).

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

Indique si ce profil reçoit des e-mails transactionnels (automatisés). Peut être `null`.

**created\_at** `string`

Horodatage ISO 8601 de création du profil.

**updated\_at** `string`

Horodatage ISO 8601 de la dernière mise à jour du profil. Peut être `null`.

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

Le panel associé à cette commande de kit à domicile — toujours exactement un (un kit à domicile
correspond en 1:1 à un kit physique), remplacé sur place lorsque tu passes `panel_id`. Consulte
les détails du panel (nom, biomarqueurs) via [Lister les panels](https://docs.anivahealth.com/fr/api/panels/list-panels.md).

**Champs d'association du panel**

**panel\_id** `string`

UUID du panel — à croiser avec [Lister les panels](https://docs.anivahealth.com/fr/api/panels/list-panels.md).

**added\_at** `string`

Horodatage ISO 8601 de la première association du panel à cette commande de kit à domicile.

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

Biomarqueurs à la carte associés à cette commande de kit à domicile en dehors de tout panel. Croise chaque
`biomarker_id` avec [Lister les biomarqueurs](https://docs.anivahealth.com/fr/api/biomarkers/list-biomarkers.md) et `home_kit=true` pour obtenir les données d'affichage.

**Champs de biomarqueur individuel**

**biomarker\_id** `integer`

Identifiant du biomarqueur — à croiser avec
[Lister les biomarqueurs](https://docs.anivahealth.com/fr/api/biomarkers/list-biomarkers.md) avec `home_kit=true`.

**added\_at** `string`

Horodatage ISO 8601 de la première association du biomarqueur à cette commande de kit à domicile.

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

Colis liés à cette commande de kit à domicile, du lien le plus ancien au plus récent — normalement le kit envoyé au patient
et l'échantillon renvoyé au laboratoire. Vide tant que la logistique n'a pas imprimé d'étiquette. Consulte les
colis complets avec [Lister les expéditions](https://docs.anivahealth.com/fr/api/shipments/list-shipments.md) et `?home_kit_order_id=`.

**Champs de lien d'expédition**

**id** `string`

Référence d'expédition — à croiser avec [Obtenir une expédition](https://docs.anivahealth.com/fr/api/shipments/get-shipment.md).

**added\_at** `string`

Horodatage ISO 8601 du lien entre l'expédition et cette commande de kit à domicile.

## Réponses d'erreur

| Statut | Description |
| - | - |
| `400` | Erreur de validation — par ex., format d'UUID invalide ou champ `delivery_address` manquant. |
| `403` | Accès refusé — ta clé API n'a pas accès à cette opération, la commande de kit à domicile est hors de ton périmètre d'autorisation, ou tu as défini `results_ready_emails` sans accès `results_view` pour le patient. |
| `404` | Commande de kit à domicile introuvable, ou le panel `panel_id` n'existe pas. |
| `409` | Conflit — la commande n'est plus `pending` ; l'adresse et le panel ne peuvent changer qu'avant l'expédition. |
| `409` | Conflit — la commande est un kit de remplacement, qui conserve le panel de la commande qu'il remplace. |
| `409` | Conflit — la commande est `cancelled` et tu as envoyé `results_ready_emails`. |
| `422` | Le panel ne peut pas être commandé en kit à domicile — aucun produit de kit d'expédition n'est configuré. |
| `500` | Erreur interne du serveur. |

```bash cURL theme={null}
curl --request PATCH \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "delivery_address": {
      "name": "Maria Schmidt",
      "street": "Unter den Linden",
      "house_number": "77",
      "postal_code": "10117",
      "city": "Berlin",
      "country_code": "DE",
      "phone": "+4930123456789",
      "email": "maria.schmidt@example.com"
    }
  }'
```

```json 200 theme={null}
{
  "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "status": "pending",
  "delivery_address": {
    "name": "Maria Schmidt",
    "street": "Unter den Linden",
    "house_number": "77",
    "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-01T13:10: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": { "your_order_ref": "ORD-10482" },
  "replaces_home_kit_order_id": null,
  "replacement_reason": null,
  "results_ready_emails": [],
  "lab_code": null,
  "activated_at": null,
  "shipments": []
}
```

```json 400 theme={null}
{
  "error": "delivery_address: Invalid input"
}
```

```json 409 theme={null}
{
  "error": "Panels and biomarkers can only be changed while the home kit order is pending. Once it is dispatched, activated, or cancelled its composition is locked."
}
```

```json 404 theme={null}
{
  "error": "Home kit order not found"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.