> ## 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/ru/concepts/idempotency.md).

> [!WARNING]
>
> Отправления нельзя отменить после забора курьером — такой запрос вернёт `409 Conflict`.

Обратную этикетку DHL нельзя отменить отдельно; это тоже возвращает `409 Conflict`. Вместо этого отмени
исходящую посылку. Отмена исходящей посылки DHL также отменяет её строки обратной доставки в статусе `pending`.
Каждая из них получает статус `cancelled` с записью `RETURN_LEG_CANCELLED` в `status_updates`. См.
[Обратные этикетки](https://docs.anivahealth.com/ru/concepts/shipments.md#vozvratnye-etiketki).

В коробке с несколькими наборами у каждого набора есть своя исходящая строка и своя обратная этикетка, даже
если коробка едет по этикетке одного из наборов. Отмена исходящей строки набора также отменяет обратную
этикетку этого набора.

Чтобы отменить посылку с домашним набором, каждый связанный заказ домашнего набора должен входить в твой контекст доступа.
Иначе запрос вернёт `403`. См. [Доступ](https://docs.anivahealth.com/ru/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`

Контактный email. Может быть `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/ru/api/shipments/get-shipment.md). Пустой массив, если событий пока не было.

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

Записи, которые были привязаны к этому отправлению до отмены. Каждый элемент имеет вид
`{ id, added_at }`; сверить каждый `id` можно через
[Получить запись](https://docs.anivahealth.com/ru/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.