Vai al contenuto principale
DELETE
Annulla un ordine di kit domiciliare impostando il suo stato su cancelled. L’ordine di kit domiciliare annullato viene restituito nella risposta. È possibile annullare solo un ordine pending. Una volta che è dispatched, il kit è stato imballato ed etichettato dalla logistica e l’annullamento restituisce 409 — così come per un ordine activated. Se il kit è già stato ordinato alla logistica, lo annulliamo lì prima di annullare il tuo, e la chiamata non va a buon fine se non accettano l’annullamento: 409 quando il kit è già imballato ed etichettato, 502 quando la logistica ha rifiutato l’annullamento o non era raggiungibile. In ogni caso di errore non cambia nulla — l’ordine rimane attivo e puoi riprovare in sicurezza dopo un 502. Annullare un ordine già cancelled restituisce 200 con quell’ordine, indipendentemente dallo stato da cui è stato annullato. La risposta include Idempotent-Replayed: true così puoi distinguere una ripetizione dalla chiamata che ha eseguito l’operazione. Consulta Idempotenza. Richiede lo scope home_kit_orders_manage.

Richiesta

Parametri di percorso

string
obbligatorio
Identificatore univoco (UUID) dell’ordine di kit domiciliare da annullare.

Risposta

In caso di successo, l’API restituisce 200 OK con l’ordine di kit domiciliare annullato e il relativo profilo incorporato. Un ordine già annullato restituisce lo stesso 200.
string
obbligatorio
Identificatore univoco dell’ordine di kit domiciliare (UUID).
string
obbligatorio
UUID del profilo a cui appartiene questo ordine di kit domiciliare.
string
obbligatorio
Stato dell’ordine di kit domiciliare. Sarà cancelled dopo un annullamento riuscito.
object
obbligatorio
L’indirizzo a cui spedire il kit — in uno di due formati: { location_id } che fa riferimento a una sede di test nota, oppure i campi dell’indirizzo inline (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email opzionali — lo stesso vocabolario dell’API delle sedi). Fornisci esattamente uno dei due — un riferimento a una sede o un indirizzo inline, non entrambi.
string
Codice campione di laboratorio con cui vengono refertati i risultati — stampato sul kit fisico e letto dal paziente sulla scatola come codice di attivazione. null finché il kit non viene imballato. Di sola lettura.
string
obbligatorio
Timestamp di raccolta segnalato tramite Attiva — quando il paziente ha raccolto il campione. null finché il kit non viene attivato.
string
L’ordine di kit domiciliare sostituito da questo, quando si tratta di un kit sostitutivo. null su un ordine normale. Consulta Crea ordine di kit domiciliare.
string
Motivo per cui è stata inviata la sostituzione. null su un ordine normale.
string[]
obbligatorio
Indirizzi che ricevono ciascuno un’email quando tutti i risultati di laboratorio sono definitivi, in minuscolo. Vuoto se disattivato. Vedi Email di risultati pronti.
object
obbligatorio
Coppie chiave/valore definite dal partner, restituite esattamente come inviate. Sempre presente — {} se non impostato.
string
obbligatorio
Timestamp ISO 8601 della creazione dell’ordine di kit domiciliare.
string
Timestamp ISO 8601 dell’ultimo aggiornamento. Può essere null.
object
obbligatorio
Il profilo del paziente associato a questo ordine di kit domiciliare.
HomeKitOrderPanel[]
obbligatorio
Il pannello associato a questo ordine di kit domiciliare prima dell’annullamento — sempre esattamente uno (un kit domiciliare corrisponde 1:1 a un prodotto kit fisico). Consulta i dettagli del pannello (nome, biomarcatori) tramite Elenca pannelli.
HomeKitOrderIndividualBiomarker[]
obbligatorio
Biomarcatori singoli associati a questo ordine di kit domiciliare prima dell’annullamento. Confronta ogni biomarker_id con Elenca biomarcatori con home_kit=true per i dati di visualizzazione.
HomeKitOrderShipmentLink[]
obbligatorio
Pacchi collegati a questo ordine di kit domiciliare prima dell’annullamento, dal collegamento più vecchio. Leggi i dettagli completi dei pacchi con Elenca spedizioni e ?home_kit_order_id=.

Risposte di errore