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

# Kanseller forsendelse

> Kanseller en forsendelsesordre

Kanseller en forsendelsesordre. Dette kaller logistikkleverandørens API for å kansellere ordren og oppdaterer forsendelsesstatusen til `cancelled`.

Å kansellere en forsendelse som allerede er `cancelled`, returnerer `200` med den forsendelsen, og leverandøren kalles bare én gang. Svaret inneholder `Idempotent-Replayed: true`, slik at du kan skille en gjentakelse fra kallet som utførte handlingen. Se [Idempotens](https://docs.anivahealth.com/no/concepts/idempotency.md).

> [!WARNING]
>
> Forsendelser kan ikke kanselleres etter henting — det returnerer `409 Conflict`.

En DHL-returetikett kan ikke kanselleres alene; det returnerer også `409 Conflict`. Kanseller
utgående pakke i stedet. Når du kansellerer en utgående DHL-pakke, kanselleres også `pending`-radene
for returen. Hver av dem får status `cancelled` med en `RETURN_LEG_CANCELLED`-oppføring i `status_updates`. Se
[Returetiketter](https://docs.anivahealth.com/no/concepts/shipments.md#returetiketter).

I en eske med flere sett har hvert sett sin egen utgående rad og sin egen returetikett, selv
når esken sendes med etiketten til ett av settene. Når du kansellerer den utgående raden for et sett,
kanselleres også returetiketten for det settet.

For å kansellere en hjemmesettpakke må hver tilknyttet hjemmesettbestilling være i tilgangskonteksten din.
Ellers returnerer kallet `403`. Se [Tilgang](https://docs.anivahealth.com/no/concepts/shipments.md#tilgang).

## Forespørsel

### Stiparametere

**id** `string` *required*

Forsendelsens referanse-ID (f.eks. `P2611194821`).

## Respons

Ved suksess returnerer API-et `200 OK` med det kansellerte forsendelsesobjektet.

**id** `string` *required*

Referanseidentifikator for forsendelsen.

**status** `string` *required*

Livssyklusstatus for forsendelsen. Vil være `cancelled` etter en vellykket kansellering.

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

Logistikkleverandør. Én av `go`, `dhl_parcel`, `dhl_warenpost`, `rotrunner`, `rapido`,
`ups` eller `dhl_express`. En hjemmesettpakke er `dhl_parcel`, eller `dhl_warenpost` når den sendes utenlands
som Warenpost International.

**tracking\_number** `string`

Eksternt sporingsnummer fra logistikkleverandøren. Kan være `null`.

**contents** `string`

Fritekstbeskrivelse av hva som er i pakken, slik den ble oppgitt ved opprettelse. Kan være `null`.

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

Hvem som skrev ut etiketten: `aniva` eller `external`. Bare `aniva`-forsendelser godtar dette kallet.

**paired\_with** `string`

Referanse til den andre pakken i en sending med to pakker. `null` for en enveispakke.

**origin** `object`

Henteadresse. Kan være `null`.

**adresseobjekt**

**name** `string` *required*

Navn på mottaker, selskap eller sted.

**company\_name** `string`

Selskap / c/o-linje. Kan være `null`.

**street** `string` *required*

Gatenavn, uten husnummer.

**house\_number** `string`

Husnummer. Kan være `null`.

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

Bygning, inngang eller etasje. Kan være `null`.

**city** `string` *required*

By.

**state** `string`

Delstat eller provins. Kan være `null`.

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

Postnummer.

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

ISO 3166-1 alpha-2-landskode.

**phone** `string`

Kontakttelefonnummer. Kan være `null`.

**email** `string`

Kontakt-e-post. Kan være `null`.

**destination** `object`

Leveringsadresse. Samme struktur som `origin`. Kan være `null`.

**pickup** `object`

Planlagt hentevindu. Kan være `null`.

**pickup-objekt**

**from** `string` *required*

Start på hentevinduet som UTC-tidspunkt (ISO 8601 med `Z`-suffiks).

**till** `string` *required*

Slutt på hentevinduet som UTC-tidspunkt (ISO 8601 med `Z`-suffiks).

**timezone** `string` *required*

IANA-tidssone for hentestedet (f.eks. `Europe/Berlin`).

**notes** `string`

Valgfrie notater. Kan være `null`.

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

Kronologiske livssyklushendelser fra logistikkleverandøren (eldste først). Hver oppføring har
`state`, `code`, `detail_code`, `status`, `description`, `location` og `time`. Se [Hent
forsendelse](https://docs.anivahealth.com/no/api/shipments/get-shipment.md) for hvert felt. Tom liste hvis ingen hendelser er
registrert ennå.

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

Timer som var koblet til denne forsendelsen før kansellering. Hver oppføring er
`{ id, added_at }`; kryssreferer hver `id` mot
[Hent time](https://docs.anivahealth.com/no/api/appointments/get-appointment.md).
Bare timene i tilgangskonteksten din vises.

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

Hjemmetestbestillinger koblet til denne forsendelsen, eldste kobling først, med samme
`{ id, added_at }`-struktur. Bare bestillingene i tilgangskonteksten din vises. Tom liste for
pakker fra praksiser.

**synced\_at** `string`

Når forsendelsen sist ble avstemt med transportøren, som et UTC-tidspunkt. `null` frem til
første synkronisering.

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

Tidsstempel for opprettelse (ISO 8601).

**updated\_at** `string`

Tidsstempel for siste oppdatering (ISO 8601). Kan være `null`.

## Feilresponser

| Status | Beskrivelse |
| - | - |
| `400` | Ugyldig ID-format. |
| `403` | Ingen tilgang — API-nøkkelen din har ikke tilgang til denne operasjonen, forsendelsen er utenfor tilgangskonteksten din, eller en koblet hjemmetestbestilling er utenfor tilgangskonteksten din. |
| `404` | Forsendelsen ble ikke funnet. |
| `409` | Forsendelsen kan ikke kanselleres — den er allerede hentet eller levert, eller den er en DHL-returetikett (kanseller den utgående pakken i stedet). |
| `501` | Forsendelsen er `external` — den ble ikke bestilt gjennom Aniva og kan ikke kanselleres her. |
| `500` | Intern serverfeil. |
| `502` | Logistikkleverandøren avviste forespørselen (f.eks. fordi kanselleringsfristen er utløpt). Inkluderer leverandørens feilmelding. |

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