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

# Создать заказ набора для домашнего теста

> Запросить набор для самостоятельного домашнего теста с доставкой по почте для профиля

Оформи заказ набора для домашнего теста для профиля пациента. При таком заказе отправляется почтовый набор для самостоятельного тестирования — Aniva высылает набор по адресу доставки, пациент сам собирает образец дома и отправляет его обратно по почте. Это отличается от [записи](https://docs.anivahealth.com/ru/api/appointments/create-appointment.md), которая представляет собой венозный забор крови в пункте тестирования.

**Требуется ровно одна панель.** Набор для домашнего теста соответствует физическому набору 1:1 — панель и есть набор, — и заказ попадает в очередь на упаковку сразу после создания, поэтому состав должен быть окончательным заранее. Ты всё ещё можешь заменить панель через [Обновление заказа набора для домашнего теста](https://docs.anivahealth.com/ru/api/home-kit-orders/update-home-kit.md), пока заказ находится в статусе `pending`.

## Наборы на замену

Если по набору не удалось получить результаты — пациент не смог наполнить пробирку, в образце оказалось слишком мало материала, лаборатория не смогла его проанализировать — закажи **замену**, передав `replaces_home_kit_order_id`.

Замена — это новый заказ с новым лабораторным кодом, даже если первый набор так и не был активирован: лаборатории нужно новое направление, а два образца под одним кодом невозможно отличить друг от друга. Заменяемый заказ остаётся без изменений — он сохраняет свой статус, свой лабораторный код и все результаты, уже привязанные к нему.

Из этого следуют две вещи:

* **Панель наследуется.** Не передавай `panel_id`, и замена получит панель заменяемого заказа — именно её купил пациент и под неё брендирована коробка.
* **Ты выбираешь, что повторить.** Передай `biomarker_ids` с маркерами, по которым анализ не удался, и лаборатория повторит только их, поэтому в наборе отправят только нужные пробирки. Не передавай это поле, чтобы повторить всю панель.

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

Одновременно в пути может быть только одна замена на один набор.

> [!NOTE]
>
> Если твоя интеграция появилась до этих полей, Aniva при создании заказа также считывает
> `metadata.original_kit_id` и `metadata.replacement_reason` и обрабатывает заказ как замену. Это
> единственное место, где метаданные интерпретируются: оно нужно только для поддержки старой
> интеграции, а поля выше всегда имеют приоритет. Передавай эти поля.

Ответ `201` означает, что заказ подтверждён и будет передан в фулфилмент — тебе больше ничего не нужно делать, чтобы набор упаковали и отправили.

Требуется право доступа `home_kit_orders_manage`.

Передай необязательный заголовок `Idempotency-Key`, чтобы этот запрос на создание можно было безопасно повторять — повтор с тем же ключом вернёт исходный ответ вместо создания второй записи. См. [Идемпотентность](https://docs.anivahealth.com/ru/concepts/idempotency.md).

## Запрос

### Параметры тела запроса

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

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

**panel\_id** `string` *required*

UUID панели из каталога для заказа. Ровно одна — набор для домашнего теста соответствует
физическому набору 1:1, поэтому панель и есть набор. ID панелей Aniva предоставляет для твоего
партнёрского аккаунта; см. [Список панелей](https://docs.anivahealth.com/ru/api/panels/list-panels.md). Необязательно для замены —
в этом случае по умолчанию используется панель заменяемого заказа.

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

UUID заказа набора для домашнего теста, который заменяет этот заказ. Передача этого поля делает
заказ набором на замену — см. [Наборы на замену](#nabory-na-zamenu) выше. Заказ должен
принадлежать тому же профилю, и для него ещё не должно быть замены в пути.

**replacement\_reason** `string`

Причина замены в одном предложении (например, `Zu wenig Material, HbA1c nicht
    auswertbar`). Обязательно при передаче `replaces_home_kit_order_id`, в остальных случаях
игнорируется. Максимум 500 символов.

**biomarker\_ids** `integer[]`

Для замены — маркеры, которые лаборатория повторит; обычно это те, по которым первый набор не
смог дать результат. Каждый из них должен входить в состав заменяемого заказа; сверь со [Списком
биомаркеров](https://docs.anivahealth.com/ru/api/biomarkers/list-biomarkers.md) с параметром `home_kit=true`. Не передавай это
поле, чтобы повторить всю панель. Принимается только вместе с `replaces_home_kit_order_id` и не
принимается вместе с другим `panel_id`. Дополнительный scope не нужен: повтор маркеров, за
которые пациент уже заплатил, не считается отдельным выбором.

**metadata** `object`

Твои собственные пары ключ/значение — возвращаются без изменений при каждом чтении и никогда не
интерпретируются Aniva. Используй это поле для передачи своего идентификатора заказа, чтобы
сопоставлять заказы без хранения наших ID. Максимум 20 ключей; ключи соответствуют
`[A-Za-z0-9_-]` и содержат не более 40 символов; значения — строка, число или логическое значение
(строки не длиннее 500 символов); общий размер в сериализованном виде — до 16 384 байт. Ключи,
начинающиеся с `aniva_`, зарезервированы. Никогда не помещай персональные или клинические данные
в `metadata` — это поле не обрабатывается как данные пациента.

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

До 5 адресов, на каждый из которых придёт одно письмо, когда все лабораторные результаты станут окончательными. В письме есть ссылка на
страницу результатов в админ-панели Aniva. Твоему ключу нужен доступ `results_view` к пациенту, иначе
вернётся `403`. Не передавай поле, чтобы использовать адреса по умолчанию для группы пациента. Пустой список отключает
отправку писем. См. [Письма о готовности результатов](https://docs.anivahealth.com/ru/concepts/results.md#pisma-o-gotovnosti-rezultatov).

**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 известного пункта тестирования для доставки набора. Сверь со [Списком
> локаций](https://docs.anivahealth.com/ru/api/locations/list-locations.md).

> [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` `DE`) требуется ровно 5 цифр, например `10117`.
>
> **country\_code** `string` *required*
>
> Код ISO 3166-1 alpha-2 (две буквы, например `DE`). Строчные буквы принимаются и сохраняются
> в верхнем регистре.
>
> **phone** `string`
>
> Номер телефона получателя с кодом страны (например, `+4791234567`). Перевозчик использует его,
> чтобы сообщать получателю о посылке — например, что она ждёт в пункте выдачи. Не передавай
> это поле, и перевозчик не получит номер телефона.
>
> **email** `string`
>
> Электронная почта получателя. Перевозчик использует её так же, как `phone`. Не передавай это
> поле, и перевозчик не получит адрес почты.

> [!NOTE]
>
> **Packstation или Postfiliale (только для Германии):** укажи в `street` значение `Packstation`
> или `Postfiliale`, в `house_number` — трёхзначный номер станции, а в `address_line_2` —
> DHL Postnummer получателя (6–10 цифр, допускаются пробелы). Без Postnummer оформить доставку
> посылки невозможно. Postfach не поддерживается.

## Ответ

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

**id** `string` *required*

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

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

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

**status** `string` *required*

Текущий статус заказа набора для домашнего теста. Одно из значений: `pending`, `dispatched`,
`activated` или `cancelled`. Только что созданный заказ получает статус `pending`.

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

**metadata** `object` *required*

Переданные тобой пары ключ/значение. Поле всегда присутствует — `{}`, если ничего не передано.

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

Заказ набора для домашнего теста, который заменяет этот заказ. `null` для обычного заказа.

**replacement\_reason** `string`

Указанная тобой причина. `null` для обычного заказа.

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

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

**lab\_code** `string`

Лабораторный код образца, под которым приходят результаты — напечатан на физическом наборе, его
пациент считывает с коробки как код активации. `null`, пока набор не упакован.
Только для чтения.

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

Время сбора образца, переданное через [Активацию](https://docs.anivahealth.com/ru/api/home-kit-orders/activate-home-kit.md). `null`,
пока набор не активирован.

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

Панель, привязанная к этому заказу набора для домашнего теста — та, что передана в `panel_id`, с
меткой времени создания заказа. Всегда ровно одна. Подробности о панели (название, биомаркеры)
смотри в [Списке панелей](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*

Биомаркеры, добавленные вне панели. При обычном создании список пуст — наборы для домашнего
теста заказываются по панелям, а для последующего изменения этого списка требуется scope
возможностей `home_kit_orders_individual_biomarker_selection`. При замене здесь находятся
переданные тобой `biomarker_ids` — именно их лаборатория повторит.

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

**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, когда отправление было связано с этим заказом набора для домашнего теста.

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

| Статус | Описание |
| - | - |
| `400` | Ошибка валидации — например, в `delivery_address` не хватает поля или в немецком почтовом индексе не 5 цифр, `panel_id` не является корректным UUID или не указан `replacement_reason` при замене. |
| `403` | Доступ запрещён — у твоего API-ключа нет прав на эту операцию, профиль находится вне области твоих разрешений или передан параметр `results_ready_emails` без доступа `results_view` к пациенту. |
| `404` | Профиль, панель или заменяемый заказ набора для домашнего теста не найдены. |
| `409` | Конфликт — ключ `Idempotency-Key` уже использовался с другим телом запроса, его исходный запрос ещё не завершён или для заменяемого набора уже есть замена в пути. |
| `422` | Панель нельзя заказать как набор для домашнего теста — для неё не настроен продукт набора в фулфилменте. Для замены: заменяемый заказ принадлежит другому профилю, один из элементов `biomarker_ids` не входил в его состав или переданы маркеры вместе с другим `panel_id`. |
| `500` | Внутренняя ошибка сервера. |

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/home-kit-orders \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
    "metadata": { "your_order_ref": "ORD-10482", "priority": true },
    "delivery_address": {
      "name": "Maria Schmidt",
      "company_name": "c/o Weber",
      "street": "Friedrichstraße",
      "house_number": "123",
      "postal_code": "10117",
      "city": "Berlin",
      "country_code": "DE",
      "phone": "+4930123456789",
      "email": "maria.schmidt@example.com"
    }
  }'
```

```bash Replacement kit theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/home-kit-orders \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "replaces_home_kit_order_id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
    "replacement_reason": "Too little material, HbA1c could not be analysed",
    "biomarker_ids": [103],
    "metadata": { "your_order_ref": "ORD-10482-R1" },
    "delivery_address": {
      "name": "Maria Schmidt",
      "street": "Friedrichstraße",
      "house_number": "123",
      "postal_code": "10117",
      "city": "Berlin",
      "country_code": "DE"
    }
  }'
```

```json 201 theme={null}
{
  "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "status": "pending",
  "delivery_address": {
    "name": "Maria Schmidt",
    "company_name": "c/o Weber",
    "address_line_2": null,
    "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": null,
  "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:45:00Z"
    }
  ],
  "individual_biomarkers": [],
  "metadata": { "your_order_ref": "ORD-10482", "priority": true },
  "replaces_home_kit_order_id": null,
  "replacement_reason": null,
  "results_ready_emails": [],
  "lab_code": null,
  "activated_at": null,
  "shipments": []
}
```

```json 400 theme={null}
{
  "error": "panel_id: panel_id must be a valid UUID"
}
```

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

```json 409 theme={null}
{
  "error": "Idempotency-Key \"ORD-10482\" was already used with a different request body. Use a new key for a different request, or resend the original body to read back its result."
}
```


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