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

# Cancel·la un enviament

> Cancel·la una ordre d'enviament

Cancel·la una comanda d'enviament. Això crida l'API del proveïdor logístic per cancel·lar la comanda i actualitza l'estat de l'enviament a `cancelled`.

Cancel·lar un enviament que ja està en estat `cancelled` retorna `200` amb aquest enviament, i el proveïdor només es crida una vegada. La resposta inclou `Idempotent-Replayed: true` perquè puguis distingir una repetició de la crida que ha fet la feina. Consulta [Idempotència](https://docs.anivahealth.com/ca/concepts/idempotency.md).

> [!WARNING]
>
> Els enviaments no es poden cancel·lar després de la recollida — això retorna `409 Conflict`.

Una etiqueta de retorn de DHL no es pot cancel·lar per si sola; això també retorna `409 Conflict`. En lloc d'això, cancel·la
el paquet d'anada. Cancel·lar un paquet d'anada de DHL també cancel·la les seves files de trajecte de retorn
en estat `pending`. Cadascuna passa a `cancelled` amb una entrada `RETURN_LEG_CANCELLED` a `status_updates`. Consulta
[Etiquetes de retorn](https://docs.anivahealth.com/ca/concepts/shipments.md#etiquetes-de-retorn).

En una caixa amb diversos kits, cada kit té la seva pròpia fila d'anada i la seva pròpia etiqueta de retorn, fins i tot
quan la caixa viatja amb l'etiqueta d'un sol kit. Cancel·lar la fila d'anada d'un kit també cancel·la l'etiqueta de retorn
d'aquest kit.

Per cancel·lar un paquet de kit a domicili, totes les comandes de kit a domicili vinculades han d'estar dins del teu context d'accés.
En cas contrari, la crida retorna `403`. Consulta [Accés](https://docs.anivahealth.com/ca/concepts/shipments.md#acces).

## Sol·licitud

### Paràmetres de ruta

**id** `string` *required*

ID de referència de l'enviament (p. ex., `P2611194821`).

## Resposta

Si té èxit, l'API retorna `200 OK` amb l'objecte d'enviament cancel·lat.

**id** `string` *required*

Identificador de referència de l'enviament.

**status** `string` *required*

Estat del cicle de vida de l'enviament. Serà `cancelled` després d'una cancel·lació correcta.

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

Proveïdor logístic. Pot ser `go`, `dhl_parcel`, `dhl_warenpost`, `rotrunner`, `rapido`,
`ups` o `dhl_express`. Un paquet de kit a domicili és `dhl_parcel`, o `dhl_warenpost` quan s'envia a l'estranger
com a Warenpost International.

**tracking\_number** `string`

Número de seguiment extern del proveïdor logístic. Pot ser `null`.

**contents** `string`

Descripció en text lliure del contingut del paquet, tal com es va indicar en crear-lo. Pot ser `null`.

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

Qui ha imprès l'etiqueta: `aniva` o `external`. Només els enviaments d'`aniva` accepten aquesta crida.

**paired\_with** `string`

Referència de l'altre paquet d'un enviament de dos paquets. `null` per a un paquet d'un sol trajecte.

**origin** `object`

Adreça de recollida. Pot ser `null`.

**objecte d'adreça**

**name** `string` *required*

Nom del destinatari, empresa o ubicació.

**company\_name** `string`

Empresa / línia c/o. Pot ser `null`.

**street** `string` *required*

Nom del carrer, sense el número.

**house\_number** `string`

Número de portal. Pot ser `null`.

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

Edifici, entrada o pis. Pot ser `null`.

**city** `string` *required*

Ciutat.

**state** `string`

Estat o província. Pot ser `null`.

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

Codi postal/ZIP.

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

Codi de país ISO 3166-1 alfa-2.

**phone** `string`

Telèfon de contacte. Pot ser `null`.

**email** `string`

Correu electrònic de contacte. Pot ser `null`.

**destination** `object`

Adreça de lliurament. Mateixa estructura que `origin`. Pot ser `null`.

**pickup** `object`

Franja de recollida programada. Pot ser `null`.

**objecte pickup**

**from** `string` *required*

Inici de la franja de recollida com a instant UTC (ISO 8601 amb el sufix `Z`).

**till** `string` *required*

Final de la franja de recollida com a instant UTC (ISO 8601 amb el sufix `Z`).

**timezone** `string` *required*

Zona horària IANA de la ubicació de recollida (p. ex., `Europe/Berlin`).

**notes** `string`

Notes opcionals. Pot ser `null`.

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

Esdeveniments cronològics del cicle de vida del proveïdor logístic (el més antic primer). Cada entrada té
`state`, `code`, `detail_code`, `status`, `description`, `location` i `time`. Consulta [Obtén
l'enviament](https://docs.anivahealth.com/ca/api/shipments/get-shipment.md) per a cada camp. Matriu buida si encara no s'ha observat cap esdeveniment.

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

Cites que estaven vinculades a aquest enviament abans de la cancel·lació. Cada entrada és
`{ id, added_at }`; consulta cada `id` a
[Obtén la cita](https://docs.anivahealth.com/ca/api/appointments/get-appointment.md).
Només es llisten les cites del teu context d'accés.

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

Comandes de kits a domicili vinculades a aquest enviament, el vincle més antic primer, amb el mateix format `{ id, added_at }`.
Només es llisten les comandes del teu context d'accés. Matriu buida per als paquets de consulta.

**synced\_at** `string`

Quan es va conciliar l'enviament per última vegada amb el transportista, com a instant UTC. `null` fins a la primera
sincronització.

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

Marca de temps de creació (ISO 8601).

**updated\_at** `string`

Marca de temps de l'última actualització (ISO 8601). Pot ser `null`.

## Respostes d'error

| Estat | Descripció |
| - | - |
| `400` | Format d'ID no vàlid. |
| `403` | Prohibit — la teva clau API no té accés a aquesta operació, l'enviament és fora del teu context d'accés o una comanda de kit a domicili vinculada és fora del teu context d'accés. |
| `404` | Enviament no trobat. |
| `409` | No es pot cancel·lar l'enviament — ja s'ha recollit o lliurat, o és una etiqueta de devolució de DHL (en lloc d'això, cancel·la el paquet d'anada). |
| `501` | L'enviament és `external` — no s'ha reservat a través d'Aniva i no es pot cancel·lar aquí. |
| `500` | Error intern del servidor. |
| `502` | El proveïdor logístic ha rebutjat la sol·licitud (p. ex., s'ha superat el termini de cancel·lació). Inclou el missatge d'error del proveïdor. |

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