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

# Thuistestkit-bestelling annuleren

> Een thuistestkit per post annuleren

Annuleer een thuistestkitbestelling door de status op `cancelled` te zetten. De geannuleerde thuistestkitbestelling wordt in de response geretourneerd.

Alleen een bestelling met de status `pending` kan worden geannuleerd. Zodra deze `dispatched` is, is de kit door fulfilment verpakt en gelabeld, en retourneert annuleren `409` — net als bij een bestelling met de status `activated`.

Als de kit al bij fulfilment is besteld, annuleren wij deze eerst daar voordat we jouw bestelling annuleren, en mislukt de aanroep als zij deze niet terugnemen: `409` als de kit al is verpakt en gelabeld, `502` als fulfilment de annulering weigerde of niet bereikbaar was. In elk foutgeval **verandert er niets** — de bestelling blijft actief en een `502` kun je veilig opnieuw proberen.

Het annuleren van een bestelling die al `cancelled` is, retourneert `200` met die bestelling, ongeacht vanuit welke status deze is geannuleerd. De response bevat `Idempotent-Replayed: true` zodat je een herhaling kunt onderscheiden van de aanroep die het werk heeft uitgevoerd. Zie [Idempotentie](https://docs.anivahealth.com/nl/concepts/idempotency.md).

Vereist de scope `home_kit_orders_manage`.

## Verzoek

### Padparameters

**id** `string` *required*

Unieke identifier (UUID) van de te annuleren thuistestkitbestelling.

## Respons

Bij succes retourneert de API `200 OK` met de geannuleerde thuistestkitbestelling en het ingesloten profiel. Een bestelling die al was geannuleerd, retourneert dezelfde `200`.

**id** `string` *required*

Unieke identifier (UUID) van de thuistestkitbestelling.

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

UUID van het profiel waarbij deze thuistestkitbestelling hoort.

**status** `string` *required*

Status van de thuistestkitbestelling. Is `cancelled` na een geslaagde annulering.

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

Het adres waar de kit naartoe wordt gestuurd — in een van twee vormen: ofwel `{ location_id }` dat verwijst naar een bekende testlocatie, ofwel de inline adresvelden (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` optioneel — dezelfde velden als de locations-API). Geef precies één vorm op — een locatieverwijzing of een inline adres, niet beide.

**bezorgadres**

> [tab] Locatieverwijzing
>
> **location\_id** `string` *required*
>
> UUID van de testlocatie waar de kit naartoe wordt verzonden.

> [tab] Inline adres
>
> **name** `string` *required*
>
> Naam van ontvanger, bedrijf of locatie.
>
> **company\_name** `string`
>
> Bedrijf dat het pakket voor de ontvanger in ontvangst neemt — een `c/o`-partij of een afdeling.
>
> **street** `string` *required*
>
> Straatnaam, zonder huisnummer (bijv. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Huisnummer (bijv. `118` of `12a`).
>
> **address\_line\_2** `string`
>
> Gebouw, ingang of verdieping.
>
> **city** `string` *required*
>
> **state** `string`
>
> Deelstaat of provincie. Optioneel.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2-code (twee letters, bijv. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Monstercode van het laboratorium waaronder de resultaten worden gerapporteerd — afgedrukt op de fysieke kit, en wat de
patiënt van de doos afleest als activeringscode. `null` totdat de kit is verpakt.
Alleen-lezen.

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

Afnametijdstempel doorgegeven via [Activeren](https://docs.anivahealth.com/nl/api/home-kit-orders/activate-home-kit.md) — wanneer de
patiënt het monster heeft afgenomen. `null` totdat de kit is geactiveerd.

**replaces\_home\_kit\_order\_id** `string`

De thuistestkitbestelling die door deze bestelling wordt vervangen, als het een vervangende kit is. `null` bij een normale bestelling. Zie
[Thuistestkitbestelling aanmaken](https://docs.anivahealth.com/nl/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Waarom de vervangende kit is verstuurd. `null` bij een normale bestelling.

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

E-mailadressen die elk één e-mail krijgen zodra alle labresultaten definitief zijn, in kleine letters. Leeg wanneer uitgeschakeld. Zie
[E-mails bij beschikbare resultaten](https://docs.anivahealth.com/nl/concepts/results.md#e-mails-zodra-resultaten-klaarstaan).

**metadata** `object` *required*

Door de partner gedefinieerde sleutel-waardeparen, letterlijk teruggegeven. Altijd aanwezig — `{}` indien niet ingesteld.

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

ISO 8601-tijdstempel waarop de thuistestkitbestelling is aangemaakt.

**updated\_at** `string`

ISO 8601-tijdstempel van de laatste update. Kan `null` zijn.

**profile** `object` *required*

Het patiëntprofiel dat bij deze thuistestkitbestelling hoort.

**profiel**

**id** `string`

Unieke profiel-identifier (UUID).

**handle** `string`

Profielhandle of gebruikersnaam. Kan `null` zijn.

**first\_name** `string`

Voornaam. Kan `null` zijn.

**last\_name** `string`

Achternaam. Kan `null` zijn.

**email** `string`

E-mailadres. Kan `null` zijn.

**phone** `string`

Telefoonnummer in E.164-formaat. Kan `null` zijn.

**sex** `integer`

Biologisch geslacht volgens ISO/IEC 5218. Kan `null` zijn.

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

Geboortedatum in `YYYY-MM-DD`-formaat. Kan `null` zijn.

**height** `number`

Lengte in centimeters. Kan `null` zijn.

**weight** `number`

Gewicht in kilogrammen. Kan `null` zijn.

**language** `string`

Voorkeurstaal: een van de 32 codes in [Profiel aanmaken](https://docs.anivahealth.com/nl/api/profiles/create-profile.md).

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

Of dit profiel transactionele (programmatische) e-mails ontvangt. Kan `null` zijn.

**created\_at** `string`

ISO 8601-tijdstempel van wanneer het profiel is aangemaakt.

**updated\_at** `string`

ISO 8601-tijdstempel van de laatste profielupdate. Kan `null` zijn.

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

Het panel dat voor annulering aan deze thuistestkitbestelling was gekoppeld — altijd precies één (een
thuistestkit komt 1:1 overeen met een fysiek kitproduct). Zoek panelgegevens (naam, biomarkers) op via
[Panels ophalen](https://docs.anivahealth.com/nl/api/panels/list-panels.md).

**Velden voor panelkoppeling**

**panel\_id** `string`

Panel-UUID — op te zoeken via [Panels ophalen](https://docs.anivahealth.com/nl/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601-tijdstempel waarop het panel voor het eerst aan deze thuistestkitbestelling is gekoppeld.

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

Losse biomarkers die voor annulering aan deze thuistestkitbestelling waren gekoppeld. Zoek
elke `biomarker_id` op via [Biomarkers ophalen](https://docs.anivahealth.com/nl/api/biomarkers/list-biomarkers.md) met `home_kit=true` voor weergavegegevens.

**Velden voor losse biomarkers**

**biomarker\_id** `integer`

Biomarker-identifier — op te zoeken via
[Biomarkers ophalen](https://docs.anivahealth.com/nl/api/biomarkers/list-biomarkers.md) met `home_kit=true`.

**added\_at** `string`

ISO 8601-tijdstempel waarop de biomarker voor het eerst aan deze thuistestkitbestelling is gekoppeld.

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

Pakketten die voor annulering aan deze thuistestkitbestelling waren gekoppeld, oudste koppeling eerst. Lees de
volledige pakketten uit met [Zendingen ophalen](https://docs.anivahealth.com/nl/api/shipments/list-shipments.md) en `?home_kit_order_id=`.

**Velden voor zendingskoppeling**

**id** `string`

Zendingsreferentie — op te zoeken via [Zending ophalen](https://docs.anivahealth.com/nl/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601-tijdstempel waarop de zending aan deze thuistestkitbestelling is gekoppeld.

## Foutresponsen

| Status | Beschrijving |
| - | - |
| `400` | Ongeldig ID-formaat — de opgegeven waarde is geen geldige UUID. |
| `403` | Toegang geweigerd — je API-sleutel heeft geen toegang tot deze bewerking, of de thuistestkitbestelling valt buiten je machtigingsscope. |
| `404` | Thuistestkitbestelling niet gevonden. |
| `409` | Conflict — de bestelling heeft niet langer de status `pending` (verzonden of geactiveerd), of de kit is al door fulfilment verpakt en gelabeld. |
| `500` | Interne serverfout. |
| `502` | Fulfilment heeft de annulering geweigerd (inclusief hun reden) of was niet bereikbaar. Er is niets veranderd; de bestelling is nog steeds actief. |

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