Перейти к основному содержанию
PATCH
Обнови адрес доставки, панель, метаданные или email-адреса для уведомлений о готовности результатов в заказе набора для домашнего теста. Укажи только те поля, которые хочешь изменить. Адрес доставки и панель можно изменить только пока заказ находится в статусе pending, так как при отгрузке физический набор уже отправляется. Поле metadata предназначено для твоего собственного учёта и остаётся доступным для записи на протяжении всего жизненного цикла заказа. Отдельных эндпоинтов для добавления и удаления панели нет: набор для домашнего теста включает ровно одну панель (он соответствует физическому продукту набора 1:1), поэтому единственная осмысленная операция с панелью — замена, которую ты выполняешь здесь. Требуется право доступа home_kit_orders_manage.

Запрос

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

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

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

Все параметры тела запроса необязательны — передавай только те поля, которые хочешь изменить.
object
Адрес для отправки набора почтой — в одном из двух форматов: либо { location_id } со ссылкой на известную локацию для сдачи анализов, либо поля адреса напрямую (name, street, city, postal_code, country_code; поля company_name / house_number / address_line_2 / state / phone / email необязательны — те же названия, что и в API локаций). Укажи ровно один вариант — ссылку на локацию или поля адреса, но не оба сразу.
Packstation или Postfiliale (только для Германии): укажи в street значение Packstation или Postfiliale, в house_number — трёхзначный номер станции, а в address_line_2 — DHL Postnummer получателя (6–10 цифр, допускаются пробелы). Без Postnummer оформить доставку посылки невозможно. Postfach не поддерживается.
string
UUID панели, которую нужно привязать вместо текущей — поскольку в наборе всегда ровно одна панель, замена является единственной осмысленной операцией. Доступно только пока заказ в статусе pending, и только для панели, для которой в Aniva настроен продукт набора для отправки (иначе 422); замена на уже привязанную панель ничего не меняет.
object
Твои собственные пары ключ/значение. Объединяются с существующими метаданными, а не заменяют их: пропущенные ключи сохраняются, ключ со значением null удаляется, а пустой объект {} очищает все данные. Ограничения те же, что и в Создании заказа набора для домашнего теста, а валидация применяется целиком — если отклонён хотя бы один ключ, ничего не записывается. Никогда не сохраняй персональные или клинические данные в metadata — они не обрабатываются как данные пациента.
string[]
Заменяет список (до 5 адресов), на каждый из которых придёт одно письмо, когда все лабораторные результаты станут окончательными. Передай [], чтобы отключить отправку писем. Поле можно менять в любом статусе, кроме cancelled. Твоему ключу нужен доступ results_view к пациенту, иначе вернётся 403. См. Письма о готовности результатов.

Ответ

В случае успеха API возвращает 200 OK с обновлённым заказом набора для домашнего теста и вложенным профилем.
string
обязательно
Уникальный идентификатор заказа набора для домашнего теста (UUID).
string
обязательно
UUID профиля, которому принадлежит этот заказ набора для домашнего теста.
string
обязательно
Текущий статус заказа набора для домашнего теста. Одно из значений: pending, dispatched, activated или cancelled.
object
обязательно
Адрес доставки набора — один из двух форматов: либо { location_id } со ссылкой на известную локацию тестирования, либо поля встроенного адреса (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email необязательны — те же поля, что и в API локаций). Укажи ровно один вариант — ссылку на локацию или встроенный адрес, но не оба сразу.
string
Лабораторный код образца, под которым приходят результаты — напечатан на физическом наборе, его пациент считывает с коробки как код активации. null, пока набор не упакован. Только для чтения.
string
обязательно
Метка времени сбора образца, переданная через Активацию — когда пациент собрал образец. null, пока набор не активирован.
string
Заказ набора для домашнего теста, который заменяется этим, если это набор на замену. null для обычного заказа. См. Создание заказа набора для домашнего теста.
string
Причина отправки замены. null для обычного заказа.
string[]
обязательно
Адреса в нижнем регистре, на каждый из которых приходит одно письмо, когда все результаты лаборатории готовы. Пустой список, если отключено. См. Письма о готовности результатов.
object
обязательно
Заданные партнёром пары ключ/значение, возвращаемые без изменений. Всегда присутствует — {}, если не задано.
string
обязательно
Метка времени создания заказа набора для домашнего теста в формате ISO 8601.
string
Временная метка последнего обновления в формате ISO 8601. Может быть null.
object
обязательно
Профиль пациента, связанный с этим заказом набора для домашнего теста.
HomeKitOrderPanel[]
обязательно
Панель, привязанная к этому заказу набора для домашнего теста — всегда ровно одна (набор для домашнего теста соответствует физическому продукту набора 1:1), заменяется на месте при передаче panel_id. Подробности о панели (название, биомаркеры) можно посмотреть через Список панелей.
HomeKitOrderIndividualBiomarker[]
обязательно
Отдельные биомаркеры, прикреплённые к этому заказу набора для домашнего теста вне какой-либо панели. Сопоставь каждый biomarker_id со Списком биомаркеров с home_kit=true, чтобы получить данные для отображения.
HomeKitOrderShipmentLink[]
обязательно
Посылки, связанные с этим заказом набора для домашнего теста, от самой старой к новой — обычно набор к пациенту и образец обратно в лабораторию. Пусто, пока фулфилмент не распечатает этикетку. Полные данные по посылкам получи через Список отправлений с ?home_kit_order_id=.

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