Заказы наборов для домашнего теста
Активировать заказ набора для домашнего теста
Сообщить, когда пациент собрал образец
POST
/
api
/
v1
/
home-kit-orders
/
{id}
/
activate
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/activate \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"activated_at": "2026-08-28T07:30:00Z"
}'
{
"id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
"profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"status": "activated",
"lab_code": "7642200101",
"activated_at": "2026-08-28T07:30:00Z",
"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-08-20T09:45:00Z",
"updated_at": "2026-08-28T07:31:12Z",
"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-08-20T09:14:32Z",
"updated_at": null
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-08-20T09:45:00Z"
}
],
"individual_biomarkers": [],
"metadata": { "your_order_ref": "ORD-10482" },
"replaces_home_kit_order_id": null,
"replacement_reason": null,
"results_ready_emails": [],
"shipments": [
{ "id": "K2608211FQ7", "added_at": "2026-08-21T08:00:00Z" },
{ "id": "K260821P3XD", "added_at": "2026-08-21T08:00:00Z" }
]
}
{
"error": "Home kit order is already activated"
}
Сообщи, что пациент собрал образец. Это аналог Подтвердить забор крови
для набора для домашнего теста — без штрихкода, потому что код наносится на набор при упаковке.
Ты передаёшь только время сбора.
Эта отметка времени имеет клиническое значение: именно это время сбора будет указано в лабораторном
отчёте. Отправляй фактический момент сбора образца пациентом, а не момент обработки в твоей
системе.
Повторная отправка того же
activated_at возвращает 200 с активированным заказом; другое значение возвращает 409. См. Идемпотентность.
Активация переводит заказ в статус activated — конечный статус. Активированный заказ больше
нельзя отменить, а его состав и адрес доставки фиксируются. Активация принимается, пока заказ
имеет статус pending или dispatched, если у него есть lab_code — набор может оказаться у
пациента раньше, чем в нашей системе появится отметка об отправке, и реальное время сбора всегда
имеет приоритет над нашим учётом. Заказ без lab_code возвращает 409: без кода образец
невозможно сопоставить с пациентом в лаборатории.
Активация также оформляет лабораторный заказ для панели набора под кодом lab_code заказа,
чтобы лаборатория ожидала образец и результаты могли прикрепиться сразу после их передачи. Это
происходит асинхронно после ответа — сбой на стороне лаборатории никогда не приводит к ошибке
твоего запроса. С этого момента Получить результаты показывает
маркеры со статусом planned, пока лаборатория не передаст их. Вебхук
home_kit_order.results.updated сообщит тебе об их изменении.
Если образец поступает в лабораторию до того, как ты активируешь набор, его активирует Aniva.
В качестве activated_at берётся утро первого события отслеживания обратной посылки или утро
поступления образца в лабораторию, если отслеживания нет. Последующий вызов с другим
activated_at в этом случае вернёт 409.
Требуется разрешение home_kit_orders_manage или более узкое разрешение home_kit_orders_activate.
Запрос
Параметры пути
Уникальный идентификатор (UUID) заказа набора для домашнего теста, который нужно активировать.
Параметры тела запроса
Время сбора образца пациентом в UTC (ISO 8601 с суффиксом
Z, например
2026-08-28T07:30:00Z). Не может быть в будущем или более чем на 30 дней в прошлом.Ответ
При успехе API возвращает200 OK с обновлённым заказом набора для домашнего теста — status имеет значение activated, а
activated_at содержит переданную тобой метку времени.
Ответы с ошибками
| Статус | Описание |
|---|---|
400 | Ошибка валидации — некорректное значение activated_at, метка времени в будущем или старше 30 дней. |
403 | Доступ запрещён — у твоего API-ключа нет доступа к этой операции или заказ набора для домашнего теста находится вне области твоих прав. |
404 | Заказ набора для домашнего теста не найден. |
409 | Конфликт — уже активирован с другим временем сбора образца, отменён или ещё не имеет lab_code. |
500 | Внутренняя ошибка сервера. |
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/activate \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"activated_at": "2026-08-28T07:30:00Z"
}'
{
"id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
"profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"status": "activated",
"lab_code": "7642200101",
"activated_at": "2026-08-28T07:30:00Z",
"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-08-20T09:45:00Z",
"updated_at": "2026-08-28T07:31:12Z",
"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-08-20T09:14:32Z",
"updated_at": null
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-08-20T09:45:00Z"
}
],
"individual_biomarkers": [],
"metadata": { "your_order_ref": "ORD-10482" },
"replaces_home_kit_order_id": null,
"replacement_reason": null,
"results_ready_emails": [],
"shipments": [
{ "id": "K2608211FQ7", "added_at": "2026-08-21T08:00:00Z" },
{ "id": "K260821P3XD", "added_at": "2026-08-21T08:00:00Z" }
]
}
{
"error": "Home kit order is already activated"
}
⌘I
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/activate \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"activated_at": "2026-08-28T07:30:00Z"
}'
{
"id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
"profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"status": "activated",
"lab_code": "7642200101",
"activated_at": "2026-08-28T07:30:00Z",
"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-08-20T09:45:00Z",
"updated_at": "2026-08-28T07:31:12Z",
"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-08-20T09:14:32Z",
"updated_at": null
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-08-20T09:45:00Z"
}
],
"individual_biomarkers": [],
"metadata": { "your_order_ref": "ORD-10482" },
"replaces_home_kit_order_id": null,
"replacement_reason": null,
"results_ready_emails": [],
"shipments": [
{ "id": "K2608211FQ7", "added_at": "2026-08-21T08:00:00Z" },
{ "id": "K260821P3XD", "added_at": "2026-08-21T08:00:00Z" }
]
}
{
"error": "Home kit order is already activated"
}