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

Получи один заказ набора для домашнего теста по его UUID, включая встроенный профиль пациента. Используй этот эндпоинт, чтобы проверить статус заказа, посмотреть адрес доставки или изучить прикреплённые панели и биомаркеры.

Требуется разрешение `home_kit_orders_view` или `home_kit_orders_manage`.

## Запрос

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

**id** `string` *required*

Уникальный идентификатор (UUID) заказа набора для домашнего теста, который нужно получить.

## Ответ

При успехе API возвращает `200 OK` с заказом набора для домашнего теста и его встроенным профилем.

**id** `string` *required*

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

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

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

**status** `string` *required*

Текущий статус заказа набора для домашнего теста. Одно из значений: `pending`, `dispatched`, `activated` или `cancelled`.
Детализация готовности лабораторных результатов определяется через [Получить результаты](https://docs.anivahealth.com/ru/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/ru/api/home-kit-orders/activate-home-kit.md) — когда
пациент собрал образец. `null`, пока набор не активирован.

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

Заказ набора для домашнего теста, который заменяется этим, если это набор на замену. `null` для обычного заказа. См.
[Создание заказа набора для домашнего теста](https://docs.anivahealth.com/ru/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Причина отправки замены. `null` для обычного заказа.

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

Адреса в нижнем регистре, на каждый из которых приходит одно письмо, когда все результаты
лаборатории готовы. Пустой список, если отключено. См.
[Письма о готовности результатов](https://docs.anivahealth.com/ru/concepts/results.md#pisma-o-gotovnosti-rezultatov).

**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/ru/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/ru/api/home-kit-orders/update-home-kit.md), пока
статус `pending`. Подробности о панели (название, биомаркеры) смотри через [Список панелей](https://docs.anivahealth.com/ru/api/panels/list-panels.md).

**Поля привязки панели**

**panel\_id** `string`

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

**added\_at** `string`

Метка времени в формате ISO 8601, когда панель была впервые привязана к этому заказу набора для домашнего теста.

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

Отдельные биомаркеры, прикреплённые к этому заказу набора для домашнего теста вне какой-либо панели. Сопоставь каждый
`biomarker_id` со [Списком биомаркеров](https://docs.anivahealth.com/ru/api/biomarkers/list-biomarkers.md) с `home_kit=true`, чтобы получить данные для отображения.

**Поля отдельных биомаркеров**

**biomarker\_id** `integer`

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

**added\_at** `string`

Метка времени в формате ISO 8601, когда биомаркер был впервые привязан к этому заказу набора для домашнего теста.

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

Посылки, связанные с этим заказом набора для домашнего теста, от самой старой к новой — обычно набор к пациенту
и образец обратно в лабораторию. Пусто, пока фулфилмент не распечатает этикетку. Полные данные
по посылкам получи через [Список отправлений](https://docs.anivahealth.com/ru/api/shipments/list-shipments.md) с `?home_kit_order_id=`.

**Поля связи с отправлением**

**id** `string`

Ссылка на отправление — сверь через [Получение отправления](https://docs.anivahealth.com/ru/api/shipments/get-shipment.md).

**added\_at** `string`

Метка времени в формате ISO 8601, когда отправление было связано с этим заказом набора для домашнего теста.

## Повторные вызовы

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

Чтобы узнавать об изменениях сразу, подпишись на события вебхуков `home_kit_order.created` и на событие каждого статуса, например `home_kit_order.activated`.
См. [Повторные запросы](https://docs.anivahealth.com/ru/concepts/webhooks.md#povtornye-chteniya).

## Ответы с ошибками

| Статус | Описание |
| - | - |
| `400` | Неверный формат ID — переданное значение не является корректным UUID. |
| `403` | Доступ запрещён — у твоего API-ключа нет доступа к этой операции или заказ набора для домашнего теста находится вне твоей области доступа. |
| `404` | Заказ набора для домашнего теста не найден. |
| `500` | Внутренняя ошибка сервера. |

```bash cURL theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a \
  --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 400 theme={null}
{
  "error": "id: Invalid home kit ID format"
}
```

```json 404 theme={null}
{
  "error": "Home kit order not found"
}
```


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