Passer au contenu principal
DELETE
Annuler une commande de kit à domicile en passant son statut à cancelled. La commande de kit à domicile annulée est renvoyée dans la réponse. Seule une commande pending peut être annulée. Une fois dispatched, le kit a été emballé et étiqueté par la logistique, et l’annulation renvoie 409 — tout comme pour une commande activated. Si le kit a déjà été commandé auprès de la logistique, nous l’y annulons avant d’annuler ta commande, et l’appel échoue si la logistique refuse de le reprendre : 409 lorsque le kit est déjà emballé et étiqueté, 502 lorsque la logistique a refusé l’annulation ou n’a pas pu être jointe. Dans tous les cas d’échec, rien n’est modifié — la commande reste active, et tu peux réessayer sans risque en cas de 502. Annuler une commande déjà cancelled renvoie 200 avec cette commande, quel que soit son statut avant l’annulation. La réponse inclut Idempotent-Replayed: true pour que tu puisses distinguer une répétition de l’appel initial. Voir Idempotence. Requiert le scope home_kit_orders_manage.

Requête

Paramètres de chemin

string
requis
Identifiant unique (UUID) de la commande de kit à domicile à annuler.

Réponse

En cas de succès, l’API renvoie 200 OK avec la commande de kit à domicile annulée et son profil intégré. Une commande déjà annulée renvoie le même 200.
string
requis
Identifiant unique de la commande de kit à domicile (UUID).
string
requis
UUID du profil auquel appartient cette commande de kit à domicile.
string
requis
Statut de la commande de kit à domicile. Sera cancelled après une annulation réussie.
object
requis
L’adresse à laquelle envoyer le kit — deux formats possibles : soit { location_id } faisant référence à un lieu de test connu, soit les champs d’adresse directe (name, street, city, postal_code, country_code ; company_name / house_number / address_line_2 / state / phone / email facultatifs — le même vocabulaire que l’API des lieux). Indique exactement un format — une référence de lieu ou une adresse directe, pas les deux.
string
Code d’échantillon de laboratoire sous lequel les résultats sont enregistrés — imprimé sur le kit physique, et que le patient lit sur la boîte comme code d’activation. null tant que le kit n’est pas emballé. En lecture seule.
string
requis
Horodatage du prélèvement transmis via Activer — moment auquel le patient a effectué son prélèvement. null tant que le kit n’est pas activé.
string
La commande de kit à domicile que celle-ci remplace, lorsqu’il s’agit d’un kit de remplacement. null pour une commande normale. Voir Créer une commande de kit à domicile.
string
Motif de l’envoi du kit de remplacement. null pour une commande normale.
string[]
requis
Adresses en minuscules qui reçoivent chacune un e-mail une fois tous les résultats de laboratoire définitifs. Vide si désactivé. Voir E-mails de résultats prêts.
object
requis
Paires clé/valeur définies par le partenaire, renvoyées telles quelles. Toujours présent — {} lorsqu’aucune valeur n’est définie.
string
requis
Horodatage ISO 8601 de la création de la commande de kit à domicile.
string
Horodatage ISO 8601 de la dernière mise à jour. Peut être null.
object
requis
Le profil patient associé à cette commande de kit à domicile.
HomeKitOrderPanel[]
requis
Le panel qui était associé à cette commande de kit à domicile avant l’annulation — toujours exactement un (un kit à domicile correspond 1:1 à un kit physique). Consulte les détails du panel (nom, biomarqueurs) via Lister les panels.
HomeKitOrderIndividualBiomarker[]
requis
Biomarqueurs à la carte qui étaient associés à cette commande de kit à domicile avant l’annulation. Croise chaque biomarker_id avec Lister les biomarqueurs avec home_kit=true pour obtenir les données d’affichage.
HomeKitOrderShipmentLink[]
requis
Colis qui étaient liés à cette commande de kit à domicile avant l’annulation, du lien le plus ancien au plus récent. Consulte les colis complets avec Lister les expéditions et ?home_kit_order_id=.

Réponses d’erreur