> ## 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-ключа

Отримай список замовлень наборів для домашнього тесту. За таким замовленням надсилається набір для самостійного тестування поштою — Aniva відправляє набір, пацієнт самостійно збирає зразок удома та надсилає його назад поштою. Кожне замовлення набору для домашнього тесту містить вбудований профіль пацієнта.

Якщо вказано `profile_id`, повертає всі замовлення наборів для домашнього тесту для цього профілю. Якщо не вказано, повертає всі доступні замовлення наборів для домашнього тесту.

Потрібен дозвіл `home_kit_orders_view` або `home_kit_orders_manage`.

## Запит

### Параметри запиту

**profile\_id** `string`

Фільтр за UUID профілю. Якщо вказано, повертаються всі замовлення наборів для домашнього тесту для цього профілю.

**lab\_code** `string`

Фільтр за лабораторним кодом (точний збіг) — знайди замовлення для фізичного набору, який у тебе в руках, за кодом,
надрукованим на ньому, наприклад перед викликом [Активувати](https://docs.anivahealth.com/uk/api/home-kit-orders/activate-home-kit.md).

## Відповідь

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

**id** `string` *required*

Унікальний ідентифікатор замовлення набору для домашнього тесту (UUID).

**profile\_id** `string` *required*

UUID профілю, якому належить це замовлення набору для домашнього тесту.

**status** `string` *required*

Поточний статус замовлення набору для домашнього тесту. Одне зі значень: `pending`, `dispatched`, `activated` або `cancelled`.
Детальний стан готовності лабораторних результатів визначається через [Отримати результати](https://docs.anivahealth.com/uk/api/home-kit-orders/get-results.md).

**delivery\_address** `object` *required*

Адреса для надсилання набору поштою — один із двох форматів: або `{ location_id }` із посиланням на відому локацію тестування, або вбудовані поля адреси (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` необов’язкові — ті самі поля, що й у API локацій). Укажи рівно один варіант — посилання на локацію або вбудовану адресу, не обидва.

**адреса доставки**

> [tab] Посилання на локацію
>
> **location\_id** `string` *required*
>
> UUID локації тестування, куди відправляється набір.

> [tab] Вбудована адреса
>
> **name** `string` *required*
>
> Ім’я отримувача, назва компанії або локації.
>
> **company\_name** `string`
>
> Компанія, що приймає посилку для отримувача — сторона `c/o` або відділ.
>
> **street** `string` *required*
>
> Назва вулиці без номера будинку (наприклад, `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Номер будинку (наприклад, `118` або `12a`).
>
> **address\_line\_2** `string`
>
> Корпус, під’їзд або поверх.
>
> **city** `string` *required*
>
> **state** `string`
>
> Штат або провінція. Необов’язково.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> Код ISO 3166-1 alpha-2 (дві літери, наприклад `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

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

**activated\_at** `string` *required*

Часова мітка забору, передана через [Активувати](https://docs.anivahealth.com/uk/api/home-kit-orders/activate-home-kit.md) — коли
пацієнт зібрав зразок. `null`, доки набір не активовано.

**replaces\_home\_kit\_order\_id** `string`

Замовлення набору для домашнього тесту, яке замінює це замовлення, якщо це набір на заміну. `null` для звичайного замовлення. Див.
[Створити замовлення набору для домашнього тесту](https://docs.anivahealth.com/uk/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Причина відправлення заміни. `null` для звичайного замовлення.

**results\_ready\_emails** `string[]` *required*

Електронні адреси в нижньому регістрі, на кожну з яких надходить один лист, коли всі лабораторні результати стають остаточними. Порожньо, якщо вимкнено. Див.
[Листи про готовність результатів](https://docs.anivahealth.com/uk/concepts/results.md#listi-pro-gotovnist-rezultativ).

**metadata** `object` *required*

Визначені партнером пари ключ/значення, що повертаються без змін. Завжди присутнє — `{}`, якщо не задано.

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

Часова мітка ISO 8601 створення замовлення набору для домашнього тесту.

**updated\_at** `string`

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

**profile** `object` *required*

Профіль пацієнта, пов’язаний із цим замовленням набору для домашнього тесту.

**Профіль**

**id** `string`

Унікальний ідентифікатор профілю (UUID).

**handle** `string`

Нікнейм або ім’я користувача профілю. Може бути `null`.

**first\_name** `string`

Ім’я. Може бути `null`.

**last\_name** `string`

Прізвище. Може бути `null`.

**email** `string`

Електронна адреса. Може бути `null`.

**phone** `string`

Номер телефону у форматі E.164. Може бути `null`.

**sex** `integer`

Біологічна стать за стандартом ISO/IEC 5218. Може бути `null`.

**date\_of\_birth** `string`

Дата народження у форматі `YYYY-MM-DD`. Може бути `null`.

**height** `number`

Зріст у сантиметрах. Може бути `null`.

**weight** `number`

Вага в кілограмах. Може бути `null`.

**language** `string`

Бажана мова: один із 32 кодів у [Створити профіль](https://docs.anivahealth.com/uk/api/profiles/create-profile.md).

**transactional\_emails\_enabled** `boolean`

Чи отримує цей профіль транзакційні (програмні) листи. Може бути `null`.

**created\_at** `string`

Часова мітка ISO 8601 створення профілю.

**updated\_at** `string`

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

**panels** `HomeKitOrderPanel[]` *required*

Панель, додана до цього замовлення набору для домашнього тесту — завжди рівно одна (набір для домашнього тесту відповідає
фізичному набору 1:1); її можна замінити через [Оновити](https://docs.anivahealth.com/uk/api/home-kit-orders/update-home-kit.md), поки статус
`pending`. Переглянь деталі панелі (назву, біомаркери) через [Список панелей](https://docs.anivahealth.com/uk/api/panels/list-panels.md).

**Поля доданої панелі**

**panel\_id** `string`

UUID панелі — звір зі [Списком панелей](https://docs.anivahealth.com/uk/api/panels/list-panels.md).

**added\_at** `string`

Часова мітка ISO 8601 першого додавання панелі до цього замовлення набору для домашнього тесту.

**individual\_biomarkers** `HomeKitOrderIndividualBiomarker[]` *required*

Окремі біомаркери, додані до цього замовлення набору для домашнього тесту поза панеллю. Звір кожен
`biomarker_id` у [Списку біомаркерів](https://docs.anivahealth.com/uk/api/biomarkers/list-biomarkers.md) із `home_kit=true`, щоб отримати дані для відображення.

**Поля окремого біомаркера**

**biomarker\_id** `integer`

Ідентифікатор біомаркера — звір
зі [Списком біомаркерів](https://docs.anivahealth.com/uk/api/biomarkers/list-biomarkers.md) з `home_kit=true`.

**added\_at** `string`

Часова мітка ISO 8601 першого додавання біомаркера до цього замовлення набору для домашнього тесту.

**shipments** `HomeKitOrderShipmentLink[]` *required*

Посилки, пов’язані з цим замовленням набору для домашнього тесту, від найдавнішої — зазвичай це набір до пацієнта
та зразок назад до лабораторії. Порожній, доки склад не роздрукує етикетку. Переглянь
повні дані посилок через [Список відправлень](https://docs.anivahealth.com/uk/api/shipments/list-shipments.md) із `?home_kit_order_id=`.

**Поля зв’язку з відправленням**

**id** `string`

Ідентифікатор відправлення — звір через [Отримати відправлення](https://docs.anivahealth.com/uk/api/shipments/get-shipment.md).

**added\_at** `string`

Часова мітка ISO 8601 прив’язки відправлення до цього замовлення набору для домашнього тесту.

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

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

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

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

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

```bash cURL (all home kit orders) theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/home-kit-orders \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (by profile) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/home-kit-orders?profile_id=a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d' \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
[
  {
    "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "status": "dispatched",
    "delivery_address": {
      "name": "Maria Schmidt",
      "street": "Friedrichstraße",
      "house_number": "123",
      "postal_code": "10117",
      "city": "Berlin",
      "country_code": "DE",
      "phone": "+4930123456789",
      "email": "maria.schmidt@example.com"
    },
    "created_at": "2026-04-01T09:45:00Z",
    "updated_at": "2026-04-02T08:00:00Z",
    "profile": {
      "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
      "handle": null,
      "first_name": "Maria",
      "last_name": "Schmidt",
      "email": "maria.schmidt@example.com",
      "phone": "+4930123456789",
      "sex": 2,
      "date_of_birth": "1985-03-22",
      "height": 168,
      "weight": 65,
      "language": "de",
      "transactional_emails_enabled": true,
      "created_at": "2026-04-01T09:14:32Z",
      "updated_at": null
    },
    "panels": [
      {
        "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
        "added_at": "2026-04-01T09:50:00Z"
      }
    ],
    "individual_biomarkers": [
      {
        "biomarker_id": 42,
        "added_at": "2026-04-01T09:52:00Z"
      }
    ],
    "metadata": {},
    "replaces_home_kit_order_id": null,
    "replacement_reason": null,
    "results_ready_emails": [],
    "lab_code": "7642000123",
    "activated_at": null,
    "shipments": [
      { "id": "K2604021FQ7", "added_at": "2026-04-02T08:00:00Z" },
      { "id": "K260402P3XD", "added_at": "2026-04-02T08:00:00Z" }
    ]
  }
]
```

```json 403 theme={null}
{
  "error": "Access denied: profile is outside your permission scope"
}
```


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