> ## 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 expédition

> Modifier les détails d'une expédition avant la collecte

Mets à jour les détails de l'envoi tels que l'horaire d'enlèvement, le nombre de colis ou les notes. Si un champ lié à la logistique change (date ou heure d'enlèvement, nombre de colis ou poids), la commande logistique existante est annulée et une nouvelle est créée automatiquement. Les champs que tu omets sont conservés tels quels depuis l'envoi existant. Les champs d'horaire mis à jour sont validés selon les [règles d'horaires d'enlèvement](https://docs.anivahealth.com/fr/concepts/shipments.md#regles-d-horaire-de-collecte).

> [!WARNING]
>
> Les envois ne peuvent pas être modifiés après l'enlèvement. Tenter de mettre à jour un envoi déjà
> enlevé renvoie `409 Conflict`.

Un colis de kit à domicile a déjà son étiquette imprimée, donc seul le champ `notes` peut changer. Un nouveau créneau d'enlèvement
ou un nouveau poids sur un colis de kit à domicile renvoie `409 Conflict` ; annule-le et crée plutôt un nouvel envoi.

Pour mettre à jour un colis de kit à domicile, chaque commande de kit à domicile liée doit faire partie de ton contexte d'accès.
Sinon, l'appel renvoie `403`. Voir [Accès](https://docs.anivahealth.com/fr/concepts/shipments.md#acces).

## Requête

### Paramètres de chemin

**id** `string` *required*

ID de référence de l'envoi (par ex. `P2611194821`).

### Paramètres du corps

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

**pickup\_date** `string`

Nouvelle date d'enlèvement au format `YYYY-MM-DD`, interprétée dans le fuseau horaire du lieu d'origine.

**pickup\_time\_from** `string`

Nouvelle heure d'enlèvement au plus tôt au format `HH:MM`, interprétée en heure locale du
lieu d'origine.

**pickup\_time\_till** `string`

Nouvelle heure d'enlèvement au plus tard au format `HH:MM`, interprétée en heure locale du
lieu d'origine.

**package\_count** `integer`

Nouveau nombre de colis.

**weight** `number`

Nouveau poids en kg.

**notes** `string`

Nouvelles notes ou remarques. 128 caractères maximum.

## Réponse

En cas de succès, l'API renvoie `200 OK` avec l'envoi mis à jour.

**id** `string` *required*

Identifiant de référence de l'envoi.

**status** `string` *required*

Statut du cycle de vie de l'envoi. Valeur parmi `pending`, `in_transit`, `delivered`, `fault` ou `cancelled`.

**logistics\_provider** `string` *required*

Prestataire logistique. L'une des valeurs `go`, `dhl_parcel`, `dhl_warenpost`, `rotrunner`, `rapido`,
`ups` ou `dhl_express`. Un colis de kit à domicile utilise `dhl_parcel`, ou `dhl_warenpost` lorsqu'il part à l'étranger
en Warenpost International.

**tracking\_number** `string`

Numéro de suivi externe du prestataire logistique. Peut être `null`.

**contents** `string`

Description libre du contenu du colis, telle que fournie à la création. Peut être `null`.

**booked\_by** `string` *required*

Qui a imprimé l'étiquette : `aniva` ou `external`. Seuls les envois `aniva` acceptent cet appel.

**paired\_with** `string`

Référence de l'autre colis d'un envoi en deux colis. `null` pour un colis aller simple.

**origin** `object`

Adresse d'enlèvement. Peut être `null`.

**objet adresse**

**name** `string` *required*

Nom du destinataire, de l'entreprise ou du lieu.

**company\_name** `string`

Ligne entreprise / chez (c/o). Peut être `null`.

**street** `string` *required*

Nom de la rue, sans le numéro.

**house\_number** `string`

Numéro de rue. Peut être `null`.

**address\_line\_2** `string`

Bâtiment, entrée ou étage. Peut être `null`.

**city** `string` *required*

Ville.

**state** `string`

État ou province. Peut être `null`.

**postal\_code** `string` *required*

Code postal.

**country\_code** `string` *required*

Code pays ISO 3166-1 alpha-2.

**phone** `string`

Numéro de téléphone de contact. Peut être `null`.

**email** `string`

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

**destination** `object`

Adresse de livraison. Même structure que `origin`. Peut être `null`.

**pickup** `object`

Créneau de collecte programmé. Peut être `null`.

**Objet pickup**

**from** `string` *required*

Début du créneau de collecte en temps UTC (ISO 8601 avec suffixe `Z`).

**till** `string` *required*

Fin du créneau de collecte en temps UTC (ISO 8601 avec suffixe `Z`).

**timezone** `string` *required*

Fuseau horaire IANA du lieu de collecte (par ex. `Europe/Berlin`). Permet d'afficher `from` / `till` à l'heure locale du lieu de collecte.

**notes** `string`

Notes facultatives. Peut être `null`.

**status\_updates** `object[]` *required*

Événements chronologiques du cycle de vie provenant du prestataire logistique (du plus ancien au plus récent). Chaque entrée contient
`state`, `code`, `detail_code`, `status`, `description`, `location` et `time`. Voir [Récupérer
un envoi](https://docs.anivahealth.com/fr/api/shipments/get-shipment.md) pour chaque champ. Tableau vide si aucun événement n'a encore été observé.

**appointments** `ShipmentAppointmentLink[]` *required*

Rendez-vous liés à cet envoi, du lien le plus ancien au plus récent. Chaque entrée a la forme `{ id, added_at }` ;
recoupe chaque `id` avec [Obtenir un rendez-vous](https://docs.anivahealth.com/fr/api/appointments/get-appointment.md).
Seuls les rendez-vous de ton contexte d'accès sont listés.

**home\_kit\_orders** `ShipmentHomeKitOrderLink[]` *required*

Commandes de kit à domicile associées à cet envoi, du lien le plus ancien au plus récent, au même format `{ id, added_at }`.
Seules les commandes de ton contexte d'accès sont listées. Tableau vide pour les colis de cabinet.

**synced\_at** `string`

Date et heure de la dernière synchronisation de l'envoi avec son transporteur, en temps UTC. `null` jusqu'à la première
synchronisation.

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

Horodatage de création (ISO 8601).

**updated\_at** `string`

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

## Réponses d'erreur

| Statut | Description |
| - | - |
| `400` | Erreur de validation — par ex., format de date ou d'heure invalide. |
| `403` | Interdit — ta clé API n'a pas accès à cette opération, l'expédition est hors de ton contexte d'accès, ou une commande de kit à domicile liée est hors de ton contexte d'accès. |
| `404` | Expédition introuvable. |
| `409` | L'expédition ne peut pas être modifiée après l'enlèvement, ou il s'agit d'un colis de kit à domicile dont l'étiquette est imprimée et la requête modifie autre chose que `notes`. |
| `501` | L'expédition est `external` — elle n'a pas été réservée via Aniva et ne peut pas être modifiée ici. |
| `500` | Erreur interne du serveur. |
| `502` | Le prestataire logistique a rejeté la requête (par ex., échec de l'annulation ou de la recréation). Inclut le message d'erreur du prestataire. |

```bash cURL theme={null}
curl --request PATCH \
  --url https://anivahealth.com/api/v1/shipments/P2611194821 \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "pickup_date": "2026-04-16",
    "pickup_time_from": "10:00",
    "pickup_time_till": "13:00"
  }'
```

```json 200 theme={null}
{
  "id": "P2611194821",
  "status": "pending",
  "logistics_provider": "go",
  "tracking_number": null,
  "contents": "Medizinisch freigestellte Probe",
  "booked_by": "aniva",
  "paired_with": null,
  "origin": {
    "name": "Aniva Berlin Mitte",
    "company_name": null,
    "street": "Unter den Linden",
    "house_number": "42",
    "address_line_2": null,
    "postal_code": "10117",
    "city": "Berlin",
    "state": null,
    "country_code": "DE",
    "phone": "+4930987654321",
    "email": "berlin-mitte@anivahealth.com"
  },
  "destination": {
    "name": "LabClinic GmbH",
    "company_name": null,
    "street": "Laborstraße",
    "house_number": "10",
    "address_line_2": null,
    "postal_code": "80331",
    "city": "München",
    "state": null,
    "country_code": "DE",
    "phone": null,
    "email": null
  },
  "pickup": {
    "from": "2026-04-16T08:00:00Z",
    "till": "2026-04-16T11:00:00Z",
    "timezone": "Europe/Berlin"
  },
  "notes": null,
  "status_updates": [],
  "appointments": [],
  "home_kit_orders": [],
  "synced_at": "2026-04-03T15:00:00Z",
  "created_at": "2026-04-03T14:30:00Z",
  "updated_at": "2026-04-03T15:10:00Z"
}
```

```json 409 theme={null}
{
  "error": "Shipment cannot be modified after pickup"
}
```

```json 502 theme={null}
{
  "error": "Logistics provider error: The cancellation notice period has already been exceeded. Cancellation is no longer possible via the web service. Please contact the GO! station.",
  "logistics_error_code": 4006
}
```


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