Перейти к основному содержанию
DELETE
Отмени заказ набора для домашнего теста, установив его статус cancelled. Отменённый заказ набора для домашнего теста возвращается в ответе. Отменить можно только заказ в статусе pending. Когда статус становится dispatched, набор уже упакован и промаркирован службой фулфилмента, и отмена возвращает 409 — так же, как и для заказа в статусе activated. Если набор уже заказан у службы фулфилмента, мы сначала отменяем его там, прежде чем отменить твой заказ, и запрос завершается ошибкой, если его не принимают обратно: 409, когда набор уже упакован и промаркирован, 502, когда служба фулфилмента отклонила отмену или не ответила. При любой ошибке ничего не меняется — заказ остаётся активным, а запрос с 502 можно безопасно повторить. Отмена заказа, который уже имеет статус cancelled, возвращает 200 с этим заказом независимо от того, из какого статуса он был отменён. Ответ содержит Idempotent-Replayed: true, так ты отличишь повторный запрос от запроса, который выполнил действие. См. Идемпотентность. Требуется право доступа home_kit_orders_manage.

Запрос

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

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

Ответ

При успехе API возвращает 200 OK с отменённым заказом набора для домашнего теста и вложенным профилем. Для уже отменённого заказа возвращается тот же статус 200.
string
обязательно
Уникальный идентификатор заказа набора для домашнего теста (UUID).
string
обязательно
UUID профиля, которому принадлежит этот заказ набора для домашнего теста.
string
обязательно
Статус заказа набора для домашнего теста. После успешной отмены принимает значение 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 физическому набору). Посмотри данные панели (название, биомаркеры) через Список панелей.
HomeKitOrderIndividualBiomarker[]
обязательно
Отдельные биомаркеры, которые были привязаны к этому заказу набора для домашнего теста до отмены. Сверь каждый biomarker_id со Списком биомаркеров с home_kit=true, чтобы получить данные для отображения.
HomeKitOrderShipmentLink[]
обязательно
Посылки, которые были связаны с этим заказом набора для домашнего теста до отмены, начиная с самой ранней. Получи полные данные о посылках через Список отправлений с ?home_kit_order_id=.

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