Salt la conținutul principal
DELETE
Anulează o comandă de kit de testare la domiciliu setându-i statusul la cancelled. Comanda de kit de testare la domiciliu anulată este returnată în răspuns. Doar o comandă pending poate fi anulată. Odată ce este dispatched, kitul a fost ambalat și etichetat de centrul logistic, iar anularea returnează 409 — la fel ca pentru o comandă activated. Dacă kitul a fost deja comandat la centrul logistic, îl anulăm acolo înainte de a anula comanda ta, iar apelul eșuează când nu îl mai pot opri: 409 când kitul este deja ambalat și etichetat, 502 când centrul logistic a refuzat anularea sau nu a putut fi contactat. În orice caz de eșec, nu se modifică nimic — comanda rămâne activă, iar un 502 poate fi reîncercat în siguranță. Anularea unei comenzi care este deja cancelled returnează 200 cu acea comandă, indiferent din ce status a fost anulată. Răspunsul conține Idempotent-Replayed: true ca să poți distinge o repetare de apelul care a efectuat operațiunea. Vezi Idempotență. Necesită scope-ul home_kit_orders_manage.

Cerere

Parametri de cale

string
obligatoriu
Identificatorul unic (UUID) al comenzii de kit de testare la domiciliu de anulat.

Răspuns

La succes, API-ul returnează 200 OK cu comanda de kit de testare la domiciliu anulată și profilul integrat al acesteia. O comandă care era deja anulată returnează același 200.
string
obligatoriu
Identificatorul unic (UUID) al comenzii de kit de testare la domiciliu.
string
obligatoriu
UUID-ul profilului căruia îi aparține această comandă de kit de testare la domiciliu.
string
obligatoriu
Statusul comenzii de kit de testare la domiciliu. Va fi cancelled după o anulare reușită.
object
obligatoriu
Adresa la care se trimite kitul — în una dintre două forme: fie { location_id } cu referire la o locație de testare cunoscută, fie câmpurile de adresă inline (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email opționale — același vocabular ca în API-ul de locații). Furnizează exact una dintre ele — o referință de locație sau o adresă inline, nu ambele.
string
Codul de probă de laborator sub care sunt raportate rezultatele — tipărit pe kitul fizic, pe care pacientul îl citește de pe cutie ca cod de activare. null până când kitul este ambalat. Doar citire.
string
obligatoriu
Marcajul temporal al recoltării raportat prin Activează — momentul în care pacientul și-a recoltat proba. null până când kitul este activat.
string
Comanda de kit de testare la domiciliu pe care o înlocuiește aceasta, când este un kit de înlocuire. null pentru o comandă obișnuită. Vezi Creează comandă de kit de testare la domiciliu.
string
Motivul pentru care a fost trimis kitul de înlocuire. null pentru o comandă obișnuită.
string[]
obligatoriu
Adresele care primesc fiecare câte un e-mail când toate rezultatele de laborator sunt finale, cu litere mici. Gol când este dezactivat. Vezi E-mailuri pentru rezultate gata.
object
obligatoriu
Perechi cheie/valoare definite de partener, returnate exact așa cum au fost trimise. Întotdeauna prezent — {} când nu este setat.
string
obligatoriu
Marcajul temporal ISO 8601 al momentului în care a fost creată comanda de kit de testare la domiciliu.
string
Timestamp ISO 8601 al ultimei actualizări. Poate fi null.
object
obligatoriu
Profilul pacientului asociat acestei comenzi de kit de testare la domiciliu.
HomeKitOrderPanel[]
obligatoriu
Panelul care era atașat acestei comenzi de kit de testare la domiciliu înainte de anulare — întotdeauna exact unul (un kit de testare la domiciliu corespunde 1:1 unui produs fizic). Consultă detaliile panelului (nume, biomarkeri) prin Listează panelurile.
HomeKitOrderIndividualBiomarker[]
obligatoriu
Biomarkeri individuali atașați acestei comenzi de kit de testare la domiciliu înainte de anulare. Corelează fiecare biomarker_id cu Listează biomarkerii cu home_kit=true pentru datele de afișare.
HomeKitOrderShipmentLink[]
obligatoriu
Colete care erau asociate acestei comenzi de kit de testare la domiciliu înainte de anulare, în ordinea vechimii asocierii. Citește coletele complete cu Listează expedierile și ?home_kit_order_id=.

Răspunsuri de eroare