Перейти до основного вмісту
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=.

Відповіді з помилками