> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancelar pedido de kit de prueba en casa

> Cancelar un kit de prueba en casa por correo

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](https://docs.anivahealth.com/es/concepts/idempotency.md).

Requiere el scope `home_kit_orders_manage`.

## Solicitud

### Parámetros de ruta

**id** `string` *required*

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`.

**id** `string` *required*

Identificador único del pedido de kit de prueba en casa (UUID).

**profile\_id** `string` *required*

UUID del perfil al que pertenece este pedido de kit de prueba en casa.

**status** `string` *required*

Estado del pedido de kit de prueba en casa. Será `cancelled` tras una cancelación correcta.

**delivery\_address** `object` *required*

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.

**dirección de entrega**

> [tab] Referencia de ubicación
>
> **location\_id** `string` *required*
>
> UUID de la ubicación de pruebas a la que se envía el kit.

> [tab] Dirección en línea
>
> **name** `string` *required*
>
> Nombre del destinatario, la empresa o la ubicación.
>
> **company\_name** `string`
>
> Empresa que recibe el paquete para el destinatario: un destinatario `c/o` o un departamento.
>
> **street** `string` *required*
>
> Nombre de la calle, sin el número (p. ej., `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Número de la calle (p. ej., `118` o `12a`).
>
> **address\_line\_2** `string`
>
> Edificio, portal o piso.
>
> **city** `string` *required*
>
> **state** `string`
>
> Estado o provincia. Opcional.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> Código ISO 3166-1 alfa-2 (dos letras, p. ej., `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `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.

**activated\_at** `string` *required*

Marca de tiempo de la recogida notificada mediante [Activar](https://docs.anivahealth.com/es/api/home-kit-orders/activate-home-kit.md): cuándo
recogió la muestra el paciente. `null` hasta que se activa el kit.

**replaces\_home\_kit\_order\_id** `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](https://docs.anivahealth.com/es/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Motivo por el que se envió la sustitución. `null` en un pedido normal.

**results\_ready\_emails** `string[]` *required*

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](https://docs.anivahealth.com/es/concepts/results.md#correos-de-resultados-listos).

**metadata** `object` *required*

Pares clave/valor definidos por el socio, devueltos tal cual. Siempre presente: `{}` si no se ha definido.

**created\_at** `string` *required*

Marca de tiempo ISO 8601 de cuándo se creó el pedido de kit de prueba en casa.

**updated\_at** `string`

Marca de tiempo ISO 8601 de la última actualización. Puede ser `null`.

**profile** `object` *required*

El perfil de paciente asociado a este pedido de kit de prueba en casa.

**perfil**

**id** `string`

Identificador único del perfil (UUID).

**handle** `string`

Alias o nombre de usuario del perfil. Puede ser `null`.

**first\_name** `string`

Nombre. Puede ser `null`.

**last\_name** `string`

Apellido. Puede ser `null`.

**email** `string`

Dirección de correo electrónico. Puede ser `null`.

**phone** `string`

Número de teléfono en formato E.164. Puede ser `null`.

**sex** `integer`

Sexo biológico según ISO/IEC 5218. Puede ser `null`.

**date\_of\_birth** `string`

Fecha de nacimiento en formato `YYYY-MM-DD`. Puede ser `null`.

**height** `number`

Altura en centímetros. Puede ser `null`.

**weight** `number`

Peso en kilogramos. Puede ser `null`.

**language** `string`

Idioma preferido: uno de los 32 códigos en [Crear perfil](https://docs.anivahealth.com/es/api/profiles/create-profile.md).

**transactional\_emails\_enabled** `boolean`

Indica si este perfil recibe correos transaccionales (programáticos). Puede ser `null`.

**created\_at** `string`

Marca de tiempo ISO 8601 de cuándo se creó el perfil.

**updated\_at** `string`

Marca de tiempo ISO 8601 de la última actualización del perfil. Puede ser `null`.

**panels** `HomeKitOrderPanel[]` *required*

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](https://docs.anivahealth.com/es/api/panels/list-panels.md).

**Campos de vinculación del panel**

**panel\_id** `string`

UUID del panel: consúltalo en [Listar paneles](https://docs.anivahealth.com/es/api/panels/list-panels.md).

**added\_at** `string`

Marca de tiempo ISO 8601 en la que se vinculó por primera vez el panel a este pedido de kit de prueba en casa.

**individual\_biomarkers** `HomeKitOrderIndividualBiomarker[]` *required*

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](https://docs.anivahealth.com/es/api/biomarkers/list-biomarkers.md) con `home_kit=true` para obtener los datos de visualización.

**Campos de biomarcadores individuales**

**biomarker\_id** `integer`

Identificador del biomarcador: consúltalo en
[Listar biomarcadores](https://docs.anivahealth.com/es/api/biomarkers/list-biomarkers.md) con `home_kit=true`.

**added\_at** `string`

Marca de tiempo ISO 8601 en la que se vinculó por primera vez el biomarcador a este pedido de kit de prueba en casa.

**shipments** `HomeKitOrderShipmentLink[]` *required*

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](https://docs.anivahealth.com/es/api/shipments/list-shipments.md) y `?home_kit_order_id=`.

**Campos de enlace de envío**

**id** `string`

Referencia del envío: consúltala en [Obtener envío](https://docs.anivahealth.com/es/api/shipments/get-shipment.md).

**added\_at** `string`

Marca de tiempo ISO 8601 en la que se vinculó el envío a este pedido de kit de prueba en casa.

## Respuestas de error

| Estado | Descripción |
| - | - |
| `400` | Formato de ID no válido: el valor proporcionado no es un UUID válido. |
| `403` | Prohibido: tu clave de API no tiene acceso a esta operación o el pedido de kit de prueba en casa está fuera de tu ámbito de permisos. |
| `404` | Pedido de kit de prueba en casa no encontrado. |
| `409` | Conflicto: el pedido ya no está en estado `pending` (enviado o activado), o el centro logístico ya ha empaquetado y etiquetado el kit. |
| `500` | Error interno del servidor. |
| `502` | El centro logístico rechazó la cancelación (incluye su motivo) o no se pudo contactar con él. No ha cambiado nada; el pedido sigue activo. |

```bash cURL theme={null}
curl --request DELETE \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "status": "cancelled",
  "delivery_address": {
    "name": "Maria Schmidt",
    "street": "Friedrichstraße",
    "house_number": "123",
    "postal_code": "10117",
    "city": "Berlin",
    "country_code": "DE",
    "phone": "+4930123456789",
    "email": "maria.schmidt@example.com"
  },
  "created_at": "2026-04-01T09:45:00Z",
  "updated_at": "2026-04-03T10:00:00Z",
  "profile": {
    "id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "handle": null,
    "first_name": "Maria",
    "last_name": "Schmidt",
    "email": "maria.schmidt@example.com",
    "phone": "+4930123456789",
    "sex": 2,
    "date_of_birth": "1985-03-22",
    "height": 168,
    "weight": 65,
    "language": "de",
    "transactional_emails_enabled": true,
    "created_at": "2026-04-01T09:14:32Z",
    "updated_at": null
  },
  "panels": [
    {
      "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
      "added_at": "2026-04-01T09:50:00Z"
    }
  ],
  "individual_biomarkers": [],
  "metadata": {},
  "replaces_home_kit_order_id": null,
  "replacement_reason": null,
  "results_ready_emails": [],
  "lab_code": null,
  "activated_at": null,
  "shipments": []
}
```

```json 404 theme={null}
{
  "error": "Home kit order not found"
}
```

```json 409 theme={null}
{
  "error": "A home kit order can only be cancelled while it is pending. Once it is dispatched or activated the physical kit has been packed and labelled and can no longer be called back."
}
```

```json 502 theme={null}
{
  "error": "Fulfilment refused the cancellation (Order is already in fulfillment). The home kit order was NOT cancelled."
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.