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

# Avbryt försändelse

> Avbryt en försändelseorder

Avboka en försändelseorder. Det här anropar logistikleverantörens API för att avboka ordern och uppdaterar försändelsens status till `cancelled`.

Att avboka en försändelse som redan har statusen `cancelled` returnerar `200` med den försändelsen, och leverantören anropas bara en gång. Svaret innehåller `Idempotent-Replayed: true` så att du kan skilja en upprepning från det anrop som utförde åtgärden. Se [Idempotens](https://docs.anivahealth.com/sv/concepts/idempotency.md).

> [!WARNING]
>
> Försändelser kan inte avbokas efter upphämtning – det returnerar `409 Conflict`.

En DHL-returetikett kan inte avbokas på egen hand; det returnerar också `409 Conflict`. Avboka det
utgående paketet i stället. När ett utgående DHL-paket avbokas avbokas även dess `pending`-rader
för retursändningen. Var och en får statusen `cancelled` med en `RETURN_LEG_CANCELLED`-post i `status_updates`. Se
[Returetiketter](https://docs.anivahealth.com/sv/concepts/shipments.md#returetiketter).

I en låda med flera kit har varje kit sin egen utgående rad och sin egen returetikett, även
när lådan skickas med ett av kitens etikett. Om du avbokar ett kits utgående rad avbokas även det
kitets returetikett.

För att avboka ett paket med hemtestkit måste varje kopplad beställning av hemtestkit finnas i din åtkomstkontext.
Annars returnerar anropet `403`. Se [Åtkomst](https://docs.anivahealth.com/sv/concepts/shipments.md#atkomst).

## Förfrågan

### Sökvägsparametrar

**id** `string` *required*

Försändelsens referens-ID (t.ex. `P2611194821`).

## Svar

Vid lyckat anrop returnerar API:et `200 OK` med det avbokade försändelseobjektet.

**id** `string` *required*

Försändelsens referensidentifierare.

**status** `string` *required*

Försändelsens livscykelstatus. Blir `cancelled` efter en lyckad avbokning.

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

Logistikleverantör. Ett av `go`, `dhl_parcel`, `dhl_warenpost`, `rotrunner`, `rapido`,
`ups` eller `dhl_express`. Ett paket med hemtestkit använder `dhl_parcel`, eller `dhl_warenpost` när det skickas utomlands
som Warenpost International.

**tracking\_number** `string`

Externt spårningsnummer från logistikleverantören. Kan vara `null`.

**contents** `string`

Fritextbeskrivning av paketets innehåll, som angavs vid skapandet. Kan vara `null`.

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

Vem som skrev ut etiketten: `aniva` eller `external`. Bara `aniva`-försändelser accepterar det här anropet.

**paired\_with** `string`

Referens till det andra paketet i en sändning med två paket. `null` för ett enkelriktat paket.

**origin** `object`

Upphämtningsadress. Kan vara `null`.

**adressobjekt**

**name** `string` *required*

Mottagare, företag eller platsnamn.

**company\_name** `string`

Företag / c/o-rad. Kan vara `null`.

**street** `string` *required*

Gatunamn utan husnummer.

**house\_number** `string`

Husnummer. Kan vara `null`.

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

Byggnad, port eller våning. Kan vara `null`.

**city** `string` *required*

Stad.

**state** `string`

Delstat eller provins. Kan vara `null`.

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

Postnummer.

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

Landskod enligt ISO 3166-1 alpha-2.

**phone** `string`

Telefonnummer för kontakt. Kan vara `null`.

**email** `string`

E-postadress för kontakt. Kan vara `null`.

**destination** `object`

Leveransadress. Samma struktur som `origin`. Kan vara `null`.

**pickup** `object`

Schemalagt upphämtningsfönster. Kan vara `null`.

**pickup-objekt**

**from** `string` *required*

Start på upphämtningsfönstret som en UTC-tidpunkt (ISO 8601 med `Z`-suffix).

**till** `string` *required*

Slut på upphämtningsfönstret som en UTC-tidpunkt (ISO 8601 med `Z`-suffix).

**timezone** `string` *required*

IANA-tidszon för upphämtningsplatsen (t.ex. `Europe/Berlin`).

**notes** `string`

Valfria anteckningar. Kan vara `null`.

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

Kronologiska livscykelhändelser från logistikleverantören (äldsta först). Varje post har
`state`, `code`, `detail_code`, `status`, `description`, `location` och `time`. Se [Hämta
försändelse](https://docs.anivahealth.com/sv/api/shipments/get-shipment.md) för respektive fält. Tom array om inga händelser har observerats ännu.

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

Bokningar som var kopplade till den här försändelsen före avbokningen. Varje post är
`{ id, added_at }`; stäm av varje `id` mot
[Hämta bokning](https://docs.anivahealth.com/sv/api/appointments/get-appointment.md).
Endast bokningarna i din åtkomstkontext listas.

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

Beställningar av hemtestkit som är kopplade till den här försändelsen, äldsta kopplingen först, med samma `{ id, added_at }`-struktur.
Endast beställningarna i din åtkomstkontext listas. Tom array för paket från mottagningar.

**synced\_at** `string`

När försändelsen senast stämdes av mot sin transportör, som en UTC-tidpunkt. `null` fram till den första
synkroniseringen.

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

Tidsstämpel för skapande (ISO 8601).

**updated\_at** `string`

Tidsstämpel för senaste uppdatering (ISO 8601). Kan vara `null`.

## Felsvar

| Status | Beskrivning |
| - | - |
| `400` | Ogiltigt ID-format. |
| `403` | Förbjudet — din API-nyckel har inte åtkomst till den här åtgärden, försändelsen ligger utanför din åtkomstkontext eller en kopplad beställning av hemtestkit ligger utanför din åtkomstkontext. |
| `404` | Försändelsen hittades inte. |
| `409` | Försändelsen kan inte avbokas — den har redan hämtats upp eller levererats, eller så är det en DHL-returetikett (avboka det utgående paketet i stället). |
| `501` | Försändelsen är `external` — den bokades inte via Aniva och kan inte avbokas här. |
| `500` | Internt serverfel. |
| `502` | Logistikleverantören avvisade begäran (t.ex. har tidsfristen för avbokning passerats). Innehåller leverantörens felmeddelande. |

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