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

# Скасувати відправлення

> Скасувати замовлення на відправлення

Скасуй замовлення на відправлення. Це викликає API логістичного провайдера для скасування замовлення та оновлює статус відправлення на `cancelled`.

Скасування відправлення, яке вже має статус `cancelled`, повертає `200` із цим відправленням, а провайдер викликається лише один раз. Відповідь містить заголовок `Idempotent-Replayed: true`, щоб можна було відрізнити повторний виклик від того, що виконав дію. Див. [Ідемпотентність](https://docs.anivahealth.com/uk/concepts/idempotency.md).

> [!WARNING]
>
> Відправлення не можна скасувати після забору відправлення — у такому разі повертається `409 Conflict`.

Зворотну етикетку DHL не можна скасувати окремо — це також повертає `409 Conflict`. Натомість
скасуй вихідну посилку. Скасування вихідної посилки DHL також скасовує пов’язані з нею рядки зворотного
відправлення зі статусом `pending`. Кожен із них отримує статус `cancelled` із записом `RETURN_LEG_CANCELLED` у `status_updates`. Див.
[Зворотні етикетки](https://docs.anivahealth.com/uk/concepts/shipments.md#etiketki-dlya-povernennya).

У коробці з кількома наборами кожен набір має власний рядок вихідного відправлення та власну зворотну етикетку, навіть
коли коробка їде за етикеткою одного з наборів. Скасування рядка вихідного відправлення набору також скасовує його
зворотну етикетку.

Щоб скасувати посилку з домашнім набором, кожне пов’язане замовлення домашнього набору має бути у твоєму контексті доступу.
Інакше запит поверне `403`. Див. [Доступ](https://docs.anivahealth.com/uk/concepts/shipments.md#dostup).

## Запит

### Параметри шляху

**id** `string` *required*

Референсний ID відправлення (наприклад, `P2611194821`).

## Відповідь

У разі успіху API повертає `200 OK` з об’єктом скасованого відправлення.

**id** `string` *required*

Ідентифікатор відправлення.

**status** `string` *required*

Статус життєвого циклу відправлення. Після успішного скасування матиме значення `cancelled`.

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

Логістичний провайдер. Одне зі значень: `go`, `dhl_parcel`, `dhl_warenpost`, `rotrunner`, `rapido`,
`ups` або `dhl_express`. Для посилки з домашнім набором це `dhl_parcel`, або `dhl_warenpost`, якщо вона прямує за кордон
як Warenpost International.

**tracking\_number** `string`

Зовнішній трек-номер від логістичного провайдера. Може бути `null`.

**contents** `string`

Опис вмісту посилки в довільній формі, вказаний під час створення. Може бути `null`.

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

Хто надрукував етикетку: `aniva` або `external`. Цей запит підтримується лише для відправлень `aniva`.

**paired\_with** `string`

Ідентифікатор іншої посилки в парному відправленні. `null` для посилки в один бік.

**origin** `object`

Адреса забору відправлення. Може бути `null`.

**об’єкт адреси**

**name** `string` *required*

Ім’я отримувача, назва компанії або локації.

**company\_name** `string`

Рядок компанії або c/o. Може бути `null`.

**street** `string` *required*

Назва вулиці без номера будинку.

**house\_number** `string`

Номер будинку. Може бути `null`.

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

Корпус, під’їзд або поверх. Може бути `null`.

**city** `string` *required*

Місто.

**state** `string`

Штат або провінція. Може бути `null`.

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

Поштовий індекс.

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

Код країни у форматі ISO 3166-1 alpha-2.

**phone** `string`

Контактний номер телефону. Може бути `null`.

**email** `string`

Контактна електронна пошта. Може бути `null`.

**destination** `object`

Адреса доставки. Така сама структура, як в `origin`. Може бути `null`.

**pickup** `object`

Заплановане вікно забору. Може бути `null`.

**об’єкт pickup**

**from** `string` *required*

Початок вікна забору як момент часу UTC (ISO 8601 із суфіксом `Z`).

**till** `string` *required*

Кінець вікна забору як момент часу UTC (ISO 8601 із суфіксом `Z`).

**timezone** `string` *required*

Часовий пояс IANA локації забору (наприклад, `Europe/Berlin`).

**notes** `string`

Необов’язкові примітки. Може бути `null`.

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

Хронологічні події життєвого циклу від логістичного провайдера (спочатку найстаріші). Кожен
елемент містить `state`, `code`, `detail_code`, `status`, `description`, `location` і `time`.
Опис кожного поля дивись в [Отримати відправлення](https://docs.anivahealth.com/uk/api/shipments/get-shipment.md). Порожній масив,
якщо подій ще не зафіксовано.

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

Записи, які були прив’язані до цього відправлення до скасування. Кожен елемент має вигляд
`{ id, added_at }`; звіряй кожен `id` через
[Отримати запис](https://docs.anivahealth.com/uk/api/appointments/get-appointment.md).
У списку лише записи з твого контексту доступу.

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

Замовлення домашніх наборів, прив’язані до цього відправлення (спочатку найдавніші), у тому ж
форматі `{ id, added_at }`. У списку лише замовлення з твого контексту доступу. Порожній масив
для посилок із практик.

**synced\_at** `string`

Коли відправлення востаннє звірялося з перевізником, як момент часу UTC. `null` до першої
синхронізації.

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

Часова мітка створення (ISO 8601).

**updated\_at** `string`

Часова мітка останнього оновлення (ISO 8601). Може бути `null`.

## Відповіді з помилками

| Статус | Опис |
| - | - |
| `400` | Некоректний формат ID. |
| `403` | Заборонено — твій API-ключ не має доступу до цієї операції, відправлення поза твоїм контекстом доступу або прив’язане замовлення домашнього набору поза твоїм контекстом доступу. |
| `404` | Відправлення не знайдено. |
| `409` | Відправлення не можна скасувати — його вже забрали або доставили, або це зворотна етикетка DHL (натомість скасуй вихідну посилку). |
| `501` | Це відправлення `external` — воно оформлене не через Aniva, тому його не можна скасувати тут. |
| `500` | Внутрішня помилка сервера. |
| `502` | Логістичний провайдер відхилив запит (наприклад, минув крайній термін скасування). Містить повідомлення про помилку від провайдера. |

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