Saltar al contenido principal
DELETE
Cancela un pedido de kit de prueba en casa cambiando su estado a cancelled. El pedido de kit de prueba en casa cancelado se devuelve en la respuesta. Solo se puede cancelar un pedido en estado pending. Una vez que pasa a dispatched, el centro logístico ya ha empaquetado y etiquetado el kit, y la cancelación devuelve 409, igual que con un pedido activated. Si el kit ya se ha pedido al centro logístico, lo cancelamos allí antes de cancelar el tuyo, y la llamada falla si no aceptan cancelarlo: 409 cuando el kit ya está empaquetado y etiquetado, y 502 cuando el centro logístico rechaza la cancelación o no se puede contactar con él. En todos los casos de error no cambia nada: el pedido sigue activo y es seguro reintentar un 502. Cancelar un pedido que ya está cancelled devuelve 200 con ese pedido, independientemente del estado desde el que se canceló. La respuesta incluye Idempotent-Replayed: true para que distingas una repetición de la llamada que realizó la acción. Consulta Idempotencia. Requiere el scope home_kit_orders_manage.

Solicitud

Parámetros de ruta

string
requerido
Identificador único (UUID) del pedido de kit de prueba en casa que quieres cancelar.

Respuesta

Si tiene éxito, la API devuelve 200 OK con el pedido de kit de prueba en casa cancelado y su perfil incrustado. Un pedido que ya estaba cancelado devuelve el mismo 200.
string
requerido
Identificador único del pedido de kit de prueba en casa (UUID).
string
requerido
UUID del perfil al que pertenece este pedido de kit de prueba en casa.
string
requerido
Estado del pedido de kit de prueba en casa. Será cancelled tras una cancelación correcta.
object
requerido
La dirección a la que se envía el kit, con uno de estos dos formatos: { location_id } para referenciar una ubicación de pruebas conocida, o los campos de dirección en línea (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email opcionales, con el mismo vocabulario que la API de ubicaciones). Indica exactamente uno: una referencia de ubicación o una dirección en línea, no ambos.
string
Código de muestra de laboratorio bajo el que se notifican los resultados: viene impreso en el kit físico y es lo que el paciente lee en la caja como código de activación. null hasta que se empaqueta el kit. Solo lectura.
string
requerido
Marca de tiempo de la recogida notificada mediante Activar: cuándo recogió la muestra el paciente. null hasta que se activa el kit.
string
El pedido de kit de prueba en casa al que sustituye este, cuando se trata de un kit de sustitución. null en un pedido normal. Consulta Crear pedido de kit de prueba en casa.
string
Motivo por el que se envió la sustitución. null en un pedido normal.
string[]
requerido
Direcciones que reciben un correo cada una cuando todos los resultados de laboratorio son definitivos, en minúsculas. Vacío cuando está desactivado. Consulta Correos de resultados listos.
object
requerido
Pares clave/valor definidos por el socio, devueltos tal cual. Siempre presente: {} si no se ha definido.
string
requerido
Marca de tiempo ISO 8601 de cuándo se creó el pedido de kit de prueba en casa.
string
Marca de tiempo ISO 8601 de la última actualización. Puede ser null.
object
requerido
El perfil de paciente asociado a este pedido de kit de prueba en casa.
HomeKitOrderPanel[]
requerido
El panel que estaba vinculado a este pedido de kit de prueba en casa antes de la cancelación: siempre exactamente uno (un kit de prueba en casa corresponde 1:1 a un kit físico). Consulta los detalles del panel (nombre, biomarcadores) mediante Listar paneles.
HomeKitOrderIndividualBiomarker[]
requerido
Biomarcadores a la carta que estaban vinculados a este pedido de kit de prueba en casa antes de la cancelación. Consulta cada biomarker_id en Listar biomarcadores con home_kit=true para obtener los datos de visualización.
HomeKitOrderShipmentLink[]
requerido
Paquetes que estaban vinculados a este pedido de kit de prueba en casa antes de la cancelación, del enlace más antiguo al más reciente. Consulta los paquetes completos con Listar envíos y ?home_kit_order_id=.

Respuestas de error