Przejdź do głównej treści
DELETE
Anuluj zamówienie domowego zestawu testowego, ustawiając jego status na cancelled. Anulowane zamówienie domowego zestawu testowego jest zwracane w odpowiedzi. Anulować można tylko zamówienie ze statusem pending. Gdy ma status dispatched, zestaw został już spakowany i zaetykietowany przez centrum realizacji, więc anulowanie zwraca 409 — tak samo jak w przypadku zamówienia ze statusem activated. Jeśli zestaw został już zamówiony w centrum realizacji, najpierw anulujemy go tam, zanim anulujemy twoje zamówienie, a wywołanie kończy się błędem, gdy centrum nie zgadza się na wycofanie: 409, gdy zestaw jest już spakowany i zaetykietowany, oraz 502, gdy centrum realizacji odrzuciło anulowanie lub nie można było się z nim połączyć. W każdym przypadku błędu nic się nie zmienia — zamówienie nadal obowiązuje, a żądanie zakończone kodem 502 można bezpiecznie ponowić. Anulowanie zamówienia, które ma już status cancelled, zwraca 200 z tym zamówieniem, niezależnie od tego, z jakiego statusu zostało anulowane. Odpowiedź zawiera Idempotent-Replayed: true, dzięki czemu odróżnisz powtórzone wywołanie od tego, które wykonało operację. Zobacz Idempotentność. Wymaga zakresu home_kit_orders_manage.

Żądanie

Parametry ścieżki

string
wymagane
Unikalny identyfikator (UUID) zamówienia domowego zestawu testowego do anulowania.

Odpowiedź

W razie powodzenia API zwraca 200 OK z anulowanym zamówieniem domowego zestawu testowego i osadzonym w nim profilem. Zamówienie, które zostało już anulowane, zwraca to samo 200.
string
wymagane
Unikalny identyfikator zamówienia domowego zestawu testowego (UUID).
string
wymagane
UUID profilu, do którego należy to zamówienie domowego zestawu testowego.
string
wymagane
Status zamówienia domowego zestawu testowego. Po pomyślnym anulowaniu będzie miał wartość cancelled.
object
wymagane
Adres, na który ma zostać wysłany zestaw — w jednej z dwóch postaci: albo { location_id } wskazujące znaną lokalizację badań, albo pola adresu wpisane bezpośrednio (name, street, city, postal_code, country_code; pola company_name / house_number / address_line_2 / state / phone / email są opcjonalne — takie samo nazewnictwo jak w API lokalizacji). Podaj dokładnie jedną opcję — odniesienie do lokalizacji albo adres wpisany bezpośrednio, nie obie naraz.
string
Kod próbki w laboratorium, pod którym raportowane są wyniki — wydrukowany na fizycznym zestawie i odczytywany przez pacjenta z pudełka jako kod aktywacyjny. null do czasu spakowania zestawu. Tylko do odczytu.
string
wymagane
Znacznik czasu pobrania zgłoszony przez Aktywuj — moment, w którym pacjent pobrał próbkę. null do czasu aktywacji zestawu.
string
Zamówienie domowego zestawu testowego, które to zamówienie zastępuje, gdy jest to zestaw zastępczy. null w przypadku zwykłego zamówienia. Zobacz Utwórz zamówienie domowego zestawu testowego.
string
Powód wysłania zestawu zastępczego. null w przypadku zwykłego zamówienia.
string[]
wymagane
Adresy zapisane małymi literami, z których każdy otrzymuje jednego e-maila, gdy wszystkie wyniki laboratoryjne będą ostateczne. Puste, gdy wyłączone. Zobacz E-maile o gotowych wynikach.
object
wymagane
Pary klucz/wartość zdefiniowane przez partnera, zwracane w niezmienionej postaci. Pole jest zawsze obecne — {}, gdy nie ustawiono żadnych wartości.
string
wymagane
Znacznik czasu ISO 8601 utworzenia zamówienia domowego zestawu testowego.
string
Znacznik czasu ISO 8601 ostatniej aktualizacji. Może mieć wartość null.
object
wymagane
Profil pacjenta powiązany z tym zamówieniem domowego zestawu testowego.
HomeKitOrderPanel[]
wymagane
Panel dołączony do tego zamówienia domowego zestawu testowego przed anulowaniem — zawsze dokładnie jeden (domowy zestaw testowy odpowiada 1:1 fizycznemu produktowi zestawu). Szczegóły panelu (nazwę, biomarkery) sprawdzisz przez Wyświetl panele.
HomeKitOrderIndividualBiomarker[]
wymagane
Pojedyncze biomarkery dołączone do tego zamówienia domowego zestawu testowego przed anulowaniem. Sprawdź każdy biomarker_id w Wyświetl biomarkery z home_kit=true, aby pobrać dane do wyświetlenia.
HomeKitOrderShipmentLink[]
wymagane
Paczki powiązane z tym zamówieniem domowego zestawu testowego przed anulowaniem, od najstarszego powiązania. Pełne informacje o paczkach pobierzesz przez Wyświetl przesyłki z ?home_kit_order_id=.

Odpowiedzi z błędami