Замовлення наборів для домашнього тесту
Активувати замовлення набору для домашнього тесту
Повідомити, коли пацієнт зібрав зразок
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.
Потрібен scope home_kit_orders_manage або вужчий scope 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"
}