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

# Отримати відправлення

> Отримати відправлення за його референсним ID

Отримай одне відправлення за його референсним ID. Відповідь надходить із нашої бази даних і
ніколи не звертається до перевізника. Фонова синхронізація оновлює кожне відправлення (кожні 10
хвилин для GO!, щогодини для DHL), а `synced_at` показує, коли востаннє опитували перевізника.

Потребує області доступу `shipments_view` або `shipments_manage`.

## Запит

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

**id** `string` *required*

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

## Відповідь

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

**id** `string` *required*

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

**status** `string` *required*

Статус життєвого циклу відправлення. Одне зі значень: `pending`, `in_transit`, `delivered`,
`fault` або `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`

Довільний текстовий опис вмісту посилки, вказаний під час створення (наприклад, `"Medizinisch
    freigestellte Probe"`, `"Home test kit"`). Лише для інформації — чи прямує посилка до
лабораторії, визначається за `destination`, а її парне відправлення — за `paired_with`. Може бути
`null`.

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

Хто надрукував етикетку: `aniva` або `external`. Лише відправлення `aniva` підтримують
[Оновлення](https://docs.anivahealth.com/uk/api/shipments/update-shipment.md) та [Скасування](https://docs.anivahealth.com/uk/api/shipments/cancel-shipment.md); посилка
`external` відстежується, але повертає `501` на обидва запити.

**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`). Використовуй для відображення `from` / `till` за місцевим часом локації забору.

**notes** `string`

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

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

Хронологічні події життєвого циклу від логістичного провайдера (спочатку найстаріші). Порожній масив, якщо
провайдер ще не передав жодної події. Використовуй це поле для відображення окремих подій в інтерфейсі, аудиту й детальніших
сигналів перевізника; для канонічного поточного стану орієнтуйся на `status`.

**поля оновлення статусу**

**state** `string | null` *required*

Подія у словнику статусів відправлення — `pending`, `in_transit`, `delivered` або
`fault` — щоб можна було читати хронологію без знання кодів перевізника. `null`, коли
подія не містить стану (створення етикетки, сканування перевізника без інформації, події, зафіксовані
до появи цього поля). Ніколи не буває `cancelled`.

**code** `string | null` *required*

Власний код статусу перевізника: у GO! це `GO10` / `GO90` / `GOY001`, у DHL — `VA` / `ZF` / `LA`
/ `ZU`. `null`, якщо перевізник його не передав. Не змінюється залежно від мови перекладу
`status`.

**detail\_code** `string | null` *required*

Детальніший код перевізника, якщо він є — поле `statusDetailed` у DHL, наприклад `CNRFC_NRQRD_ZF`
(перенаправлено до поштового відділення), `HLDCC_SERPT_LA` (готово до видачі там), `DLVRD_SERPT_ZU`
(отримано). `null` для перевізників без такого коду.

**status** `string` *required*

Текст статусу від провайдера (довільний текст, наприклад `"Shipment picked up"`,
`"Die Sendung wurde abgeholt."`).

**description** `string | null` *required*

Пояснення коду або розгорнутіший опис від перевізника. `null`, якщо немає жодного з них.

**location** `string | null` *required*

Місце сканування так, як його називає перевізник — депо GO! (`"HUB Niederaula"`) або
місто DHL. Довільний текст, не координати. `null`, якщо перевізник не передав місце.

**time** `string` *required*

Час фіксації події (ISO 8601, зі зміщенням часового поясу, яке передав перевізник).

**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 }`.
Використай кожен `id` в [Отримати замовлення набору для домашнього тесту](https://docs.anivahealth.com/uk/api/home-kit-orders/get-home-kit.md). Порожній
масив для посилок із практик. У списку лише замовлення у твоєму контексті доступу. Див.
[Доступ](https://docs.anivahealth.com/uk/concepts/shipments.md#dostup).

**synced\_at** `string`

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

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

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

**updated\_at** `string`

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

## Повторні виклики

Aniva зберігає відповідь цього ендпоінта протягом 60 хвилин для кожного API-ключа. Повторний виклик у межах
цього часу отримує збережену відповідь, доки відправлення не змінилося. Після зміни ти отримуєш свіжу
відповідь. Заголовки `Cache-Status` і `Age` показують, що відповідь
збережена та скільки їй часу.

У збереженій відповіді значення `synced_at` і `updated_at` можуть бути старішими, ніж у свіжій відповіді.

Щоб дізнаватися про зміни одразу, підпишись на вебхук-події `shipment.created` і `shipment.updated`.
Див. [Повторні читання](https://docs.anivahealth.com/uk/concepts/webhooks.md#povtorni-chitannya).

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

| Статус | Опис |
| - | - |
| `400` | Неправильний формат ID. |
| `403` | Доступ заборонено — твій API-ключ не має доступу до цієї операції або відправлення перебуває поза твоїм контекстом доступу. Посилка входить у твій контекст доступу, якщо в нього входить принаймні один пов’язаний запис або замовлення набору для домашнього тесту. |
| `404` | Відправлення не знайдено. |
| `500` | Внутрішня помилка сервера. |

```bash cURL theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/shipments/P2611194821 \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "id": "P2611194821",
  "status": "in_transit",
  "logistics_provider": "go",
  "tracking_number": "GO123456789",
  "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": [
    {
      "state": "in_transit",
      "code": "GO10",
      "detail_code": null,
      "status": "Shipment picked up",
      "description": "Picked up at the consignor",
      "location": "Berlin",
      "time": "2026-04-15T09:22:00+02:00"
    },
    {
      "state": "in_transit",
      "code": "GO50",
      "detail_code": null,
      "status": "Receiving station",
      "description": null,
      "location": "HUB Niederaula",
      "time": "2026-04-15T11:18:00+02:00"
    }
  ],
  "appointments": [
    {
      "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
      "added_at": "2026-04-15T08:30:00Z"
    }
  ],
  "home_kit_orders": [],
  "synced_at": "2026-04-15T11:20:00Z",
  "created_at": "2026-04-03T14:30:00Z",
  "updated_at": "2026-04-15T11:20:00Z"
}
```

```json 404 theme={null}
{
  "error": "Shipment not found"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.