Přejít na hlavní obsah
DELETE
Zruš objednávku domácí testovací sady nastavením jejího stavu na cancelled. V odpovědi se vrátí zrušená objednávka domácí testovací sady. Zrušit lze pouze objednávku ve stavu pending. Jakmile má stav dispatched, expedice sadu zabalila a opatřila štítkem a zrušení vrátí 409 — stejně jako u objednávky ve stavu activated. Pokud už byla sada objednána u expedice, zrušíme ji nejprve tam a pak tu tvou; volání selže, když ji nevezmou zpět: 409, když už je sada zabalená a opatřená štítkem, 502, když expedice zrušení odmítla nebo byla nedostupná. Při jakémkoli selhání se nic nezmění — objednávka zůstává platná a 502 můžeš bezpečně zkusit znovu. Zrušení objednávky, která už má stav cancelled, vrátí 200 s touto objednávkou bez ohledu na to, z jakého stavu byla zrušena. Odpověď obsahuje Idempotent-Replayed: true, takže rozeznáš opakovaný požadavek od volání, které změnu skutečně provedlo. Viz Idempotence. Vyžaduje scope home_kit_orders_manage.

Požadavek

Parametry cesty

string
povinné
Jedinečný identifikátor (UUID) objednávky domácí testovací sady, kterou chceš zrušit.

Odpověď

Při úspěchu API vrátí 200 OK se zrušenou objednávkou domácí testovací sady a jejím vnořeným profilem. Objednávka, která už byla zrušena, vrátí stejné 200.
string
povinné
Jedinečný identifikátor objednávky domácí testovací sady (UUID).
string
povinné
UUID profilu, ke kterému tato objednávka domácí testovací sady patří.
string
povinné
Stav objednávky domácí testovací sady. Po úspěšném zrušení bude cancelled.
object
povinné
Adresa pro doručení sady — jedna ze dvou podob: buď { location_id } s odkazem na známé testovací místo, nebo přímo vložená pole adresy (name, street, city, postal_code, country_code; nepovinně company_name / house_number / address_line_2 / state / phone / email — stejný slovník jako v locations API). Uveď přesně jednu variantu — odkaz na místo, nebo přímou adresu, ne obojí.
string
Laboratorní kód vzorku, pod kterým se hlásí výsledky — je vytištěný na fyzické sadě a pacient ho přečte z krabičky jako aktivační kód. null, dokud není sada zabalená. Pouze pro čtení.
string
povinné
Časové razítko odběru nahlášené přes Aktivace — kdy pacient odebral vzorek. null, dokud sada není aktivovaná.
string
Objednávka domácí testovací sady, kterou tato nahrazuje, pokud jde o náhradní sadu. null u běžné objednávky. Viz Vytvoření objednávky domácí testovací sady.
string
Důvod odeslání náhradní sady. null u běžné objednávky.
string[]
povinné
Adresy malými písmeny, z nichž každá dostane jeden e-mail, jakmile jsou všechny laboratorní výsledky konečné. Prázdné, když je vypnuto. Viz E-maily o připravených výsledcích.
object
povinné
Páry klíč/hodnota definované partnerem, vrácené beze změny. Vždy přítomné — {}, pokud nejsou nastaveny.
string
povinné
Časové razítko ve formátu ISO 8601, kdy byla objednávka domácí testovací sady vytvořena.
string
Časové razítko ISO 8601 poslední aktualizace. Může být null.
object
povinné
Profil pacienta spojený s touto objednávkou domácí testovací sady.
HomeKitOrderPanel[]
povinné
Panel přiřazený k této objednávce domácí testovací sady před zrušením — vždy přesně jeden (domácí testovací sada odpovídá fyzickému produktu sady 1:1). Detaily panelu (název, biomarkery) najdeš přes Seznam panelů.
HomeKitOrderIndividualBiomarker[]
povinné
Samostatné biomarkery přiřazené k této objednávce domácí testovací sady před zrušením. Údaje pro zobrazení u každého biomarker_id dohledáš přes Seznam biomarkerů s home_kit=true.
HomeKitOrderShipmentLink[]
povinné
Balíky propojené s touto objednávkou domácí testovací sady před zrušením, od nejstaršího propojení. Kompletní údaje o balících načteš přes Seznam zásilek s ?home_kit_order_id=.

Chybové odpovědi