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

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

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

Обнови адрес доставки, панель, метаданные или email-адреса для уведомлений о готовности результатов в заказе набора для домашнего теста. Укажи только те поля, которые хочешь изменить.

Адрес доставки и панель можно изменить только пока заказ находится в статусе `pending`, так как при отгрузке физический набор уже отправляется. Поле `metadata` предназначено для твоего собственного учёта и остаётся доступным для записи на протяжении всего жизненного цикла заказа.

Отдельных эндпоинтов для добавления и удаления панели нет: набор для домашнего теста включает ровно одну панель (он соответствует физическому продукту набора 1:1), поэтому единственная осмысленная операция с панелью — замена, которую ты выполняешь здесь.

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

## Запрос

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

**id** `string` *required*

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

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

Все параметры тела запроса необязательны — передавай только те поля, которые хочешь изменить.

**delivery\_address** `object`

Адрес для отправки набора почтой — в одном из двух форматов: либо `{ 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 не поддерживается.

**panel\_id** `string`

UUID панели, которую нужно привязать вместо текущей — поскольку в наборе всегда ровно одна панель,
замена является единственной осмысленной операцией. Доступно только пока заказ в статусе `pending`,
и только для панели, для которой в Aniva настроен продукт набора для отправки (иначе `422`);
замена на уже привязанную панель ничего не меняет.

**metadata** `object`

Твои собственные пары ключ/значение. **Объединяются** с существующими метаданными, а не заменяют их:
пропущенные ключи сохраняются, ключ со значением `null` удаляется, а пустой объект `{}` очищает
все данные. Ограничения те же, что и в [Создании заказа набора для домашнего теста](https://docs.anivahealth.com/ru/api/home-kit-orders/create-home-kit.md),
а валидация применяется целиком — если отклонён хотя бы один ключ, ничего не записывается.
Никогда не сохраняй персональные или клинические данные в `metadata` — они не обрабатываются как данные пациента.

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

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

## Ответ

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

**id** `string` *required*

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

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

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

**status** `string` *required*

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

**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), заменяется на месте при передаче `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*

Отдельные биомаркеры, прикреплённые к этому заказу набора для домашнего теста вне какой-либо панели. Сопоставь каждый
`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, когда отправление было связано с этим заказом набора для домашнего теста.

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

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

```bash cURL theme={null}
curl --request PATCH \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "delivery_address": {
      "name": "Maria Schmidt",
      "street": "Unter den Linden",
      "house_number": "77",
      "postal_code": "10117",
      "city": "Berlin",
      "country_code": "DE",
      "phone": "+4930123456789",
      "email": "maria.schmidt@example.com"
    }
  }'
```

```json 200 theme={null}
{
  "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "status": "pending",
  "delivery_address": {
    "name": "Maria Schmidt",
    "street": "Unter den Linden",
    "house_number": "77",
    "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-01T13:10: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": [],
  "metadata": { "your_order_ref": "ORD-10482" },
  "replaces_home_kit_order_id": null,
  "replacement_reason": null,
  "results_ready_emails": [],
  "lab_code": null,
  "activated_at": null,
  "shipments": []
}
```

```json 400 theme={null}
{
  "error": "delivery_address: Invalid input"
}
```

```json 409 theme={null}
{
  "error": "Panels and biomarkers can only be changed while the home kit order is pending. Once it is dispatched, activated, or cancelled its composition is locked."
}
```

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