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

# Zending annuleren

> Een verzendopdracht annuleren

Annuleer een verzendorder. Dit roept de API van de vervoerder aan om de order te annuleren en werkt de status van de zending bij naar `cancelled`.

Als je een zending annuleert die al `cancelled` is, krijg je `200` terug met die zending en wordt de vervoerder maar één keer aangeroepen. De response bevat `Idempotent-Replayed: true`, zodat je een herhaling kunt onderscheiden van de aanroep die het werk heeft gedaan. Zie [Idempotentie](https://docs.anivahealth.com/nl/concepts/idempotency.md).

> [!WARNING]
>
> Zendingen kunnen na het ophalen niet meer worden geannuleerd — dat geeft `409 Conflict` terug.

Een DHL-retourlabel kan niet op zichzelf worden geannuleerd; ook dat geeft `409 Conflict` terug. Annuleer
in plaats daarvan het uitgaande pakket. Als je een uitgaand DHL-pakket annuleert, worden ook de `pending`
retourrijen ervan geannuleerd. Elke rij wordt `cancelled` met een `RETURN_LEG_CANCELLED`-vermelding in `status_updates`. Zie
[Retourlabels](https://docs.anivahealth.com/nl/concepts/shipments.md#retourlabels).

In een doos met meerdere kits heeft elke kit een eigen uitgaande rij en een eigen retourlabel, zelfs
als de doos op het label van één kit meereist. Als je de uitgaande rij van een kit annuleert, wordt ook het
retourlabel van die kit geannuleerd.

Om een pakket met een thuistestkit te annuleren, moet elke gekoppelde bestelling voor een thuistestkit binnen je toegangscontext vallen.
Anders geeft de aanroep `403` terug. Zie [Toegang](https://docs.anivahealth.com/nl/concepts/shipments.md#toegang).

## Verzoek

### Padparameters

**id** `string` *required*

Referentie-ID van de zending (bijv. `P2611194821`).

## Respons

Bij succes geeft de API `200 OK` terug met het geannuleerde zendingobject.

**id** `string` *required*

Referentie-identifier van de zending.

**status** `string` *required*

Status in de levenscyclus van de zending. Is `cancelled` na een geslaagde annulering.

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

Vervoerder. Een van `go`, `dhl_parcel`, `dhl_warenpost`, `rotrunner`, `rapido`,
`ups` of `dhl_express`. Een pakket met een thuistestkit is `dhl_parcel`, of `dhl_warenpost` wanneer het naar het buitenland gaat
als Warenpost International.

**tracking\_number** `string`

Extern trackingnummer van de vervoerder. Kan `null` zijn.

**contents** `string`

Vrije tekstbeschrijving van wat er in het pakket zit, zoals opgegeven bij het aanmaken. Kan `null` zijn.

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

Wie het label heeft afgedrukt: `aniva` of `external`. Alleen `aniva`-zendingen accepteren deze aanroep.

**paired\_with** `string`

Referentie van het andere pakket in een zending van twee pakketten. `null` voor een pakket in één richting.

**origin** `object`

Ophaaladres. Kan `null` zijn.

**adresobject**

**name** `string` *required*

Naam van ontvanger, bedrijf of locatie.

**company\_name** `string`

Bedrijf / p/a-regel. Kan `null` zijn.

**street** `string` *required*

Straatnaam, zonder huisnummer.

**house\_number** `string`

Huisnummer. Kan `null` zijn.

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

Gebouw, ingang of verdieping. Kan `null` zijn.

**city** `string` *required*

Plaats.

**state** `string`

Staat of provincie. Kan `null` zijn.

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

Postcode.

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

ISO 3166-1 alpha-2-landcode.

**phone** `string`

Telefoonnummer voor contact. Kan `null` zijn.

**email** `string`

E-mailadres voor contact. Kan `null` zijn.

**destination** `object`

Bezorgadres. Zelfde structuur als `origin`. Kan `null` zijn.

**pickup** `object`

Gepland ophaalvenster. Kan `null` zijn.

**pickup-object**

**from** `string` *required*

Begin van het ophaalvenster als UTC-tijdstip (ISO 8601 met `Z`-achtervoegsel).

**till** `string` *required*

Einde van het ophaalvenster als UTC-tijdstip (ISO 8601 met `Z`-achtervoegsel).

**timezone** `string` *required*

IANA-tijdzone van de ophaallocatie (bijv. `Europe/Berlin`).

**notes** `string`

Optionele notities. Kan `null` zijn.

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

Chronologische levenscyclusgebeurtenissen van de logistieke dienstverlener (oudste eerst). Elk item heeft
`state`, `code`, `detail_code`, `status`, `description`, `location` en `time`. Zie [Zending
ophalen](https://docs.anivahealth.com/nl/api/shipments/get-shipment.md) voor elk veld. Lege array als er nog geen gebeurtenissen zijn waargenomen.

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

Afspraken die vóór annulering aan deze zending waren gekoppeld. Elk item is
`{ id, added_at }`; zoek elke `id` op via
[Afspraak ophalen](https://docs.anivahealth.com/nl/api/appointments/get-appointment.md).
Alleen de afspraken binnen je toegangscontext worden vermeld.

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

Thuistestbestellingen gekoppeld aan deze zending, oudste koppeling eerst, in dezelfde `{ id, added_at }`-structuur.
Alleen de bestellingen binnen je toegangscontext worden vermeld. Lege array voor praktijkpakketten.

**synced\_at** `string`

Wanneer de zending voor het laatst met de vervoerder is gesynchroniseerd, als UTC-tijdstip. `null` tot de eerste
synchronisatie.

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

Tijdstempel van aanmaken (ISO 8601).

**updated\_at** `string`

Tijdstempel van laatste update (ISO 8601). Kan `null` zijn.

## Foutresponsen

| Status | Beschrijving |
| - | - |
| `400` | Ongeldige ID-indeling. |
| `403` | Verboden — je API-sleutel heeft geen toegang tot deze bewerking, de zending valt buiten je toegangscontext of een gekoppelde thuistestbestelling valt buiten je toegangscontext. |
| `404` | Zending niet gevonden. |
| `409` | Zending kan niet worden geannuleerd — deze is al opgehaald of bezorgd, of het is een DHL-retourlabel (annuleer in plaats daarvan het uitgaande pakket). |
| `501` | De zending is `external` — deze is niet via Aniva geboekt en kan hier niet worden geannuleerd. |
| `500` | Interne serverfout. |
| `502` | De logistieke dienstverlener heeft het verzoek afgewezen (bijv. annuleringstermijn verstreken). Bevat de foutmelding van de dienstverlener. |

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