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

# Annuler une expédition

> Annuler une commande d'expédition

Annule une commande d'envoi. Cet appel contacte l'API du prestataire logistique pour annuler la commande et passe le statut de l'envoi à `cancelled`.

Annuler un envoi déjà `cancelled` renvoie `200` avec cet envoi, et le prestataire n'est appelé qu'une seule fois. La réponse inclut `Idempotent-Replayed: true` pour que tu puisses distinguer une répétition de l'appel qui a effectué l'action. Voir [Idempotence](https://docs.anivahealth.com/fr/concepts/idempotency.md).

> [!WARNING]
>
> Les envois ne peuvent pas être annulés après l'enlèvement — cela renvoie `409 Conflict`.

Une étiquette retour DHL ne peut pas être annulée seule ; cela renvoie aussi `409 Conflict`. Annule
plutôt le colis aller. Annuler un colis aller DHL annule également ses lignes de trajet retour
`pending`. Chacune passe à `cancelled` avec une entrée `RETURN_LEG_CANCELLED` dans `status_updates`. Voir
[Étiquettes retour](https://docs.anivahealth.com/fr/concepts/shipments.md#etiquettes-de-retour).

Dans un carton contenant plusieurs kits, chaque kit a sa propre ligne aller et sa propre étiquette retour, même
lorsque le carton voyage avec l'étiquette d'un seul kit. Annuler la ligne aller d'un kit annule aussi l'étiquette
retour de ce kit.

Pour annuler un colis de kit à domicile, chaque commande de kit à domicile liée doit se trouver dans 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`).

## Réponse

En cas de succès, l'API renvoie `200 OK` avec l'objet de l'envoi annulé.

**id** `string` *required*

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

**status** `string` *required*

Statut du cycle de vie de l'envoi. Sera `cancelled` après une annulation réussie.

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

**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 qui étaient associés à cet envoi avant l'annulation. Chaque entrée a la forme
`{ id, added_at }` ; recoupe chaque `id` avec
[Récupérer 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` | Format d'ID invalide. |
| `403` | Accès refusé — ta clé API n'a pas accès à cette opération, l'envoi est hors de ton contexte d'accès ou une commande de kit à domicile associée est hors de ton contexte d'accès. |
| `404` | Envoi introuvable. |
| `409` | L'envoi ne peut pas être annulé — il a déjà été collecté ou livré, ou il s'agit d'une étiquette de retour DHL (annule plutôt le colis aller). |
| `501` | L'envoi est `external` — il n'a pas été réservé via Aniva et ne peut pas être annulé ici. |
| `500` | Erreur interne du serveur. |
| `502` | Le prestataire logistique a rejeté la requête (par ex. délai d'annulation dépassé). Inclut le message d'erreur du prestataire. |

```bash cURL theme={null}
curl --request DELETE \
  --url https://anivahealth.com/api/v1/shipments/P2611194821 \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "id": "P2611194821",
  "status": "cancelled",
  "logistics_provider": "go",
  "tracking_number": "GO1234567890",
  "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-15T07:00:00Z",
    "till": "2026-04-15T10: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-03T16:45:00Z"
}
```

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

```json 409 (return label) theme={null}
{
  "error": "Shipment K260904P3XD is the return label of K2609041FQ7. DHL cannot cancel a return label on its own. Cancel the outbound parcel while it is pending. After the outbound parcel ships, the label stays valid and Aniva closes this shipment manually."
}
```

```json 403 (Aniva-managed parcel) theme={null}
{
  "error": "Access denied: only Aniva can change this parcel."
}
```

```json 404 theme={null}
{
  "error": "Shipment not found"
}
```

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