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

# Annuller ordre på hjemmetestkit

> Annuller et postsendt hjemmetestkit

Annuller en hjemmetestkitordre ved at sætte dens status til `cancelled`. Den annullerede hjemmetestkitordre returneres i svaret.

Kun en ordre, der er `pending`, kan annulleres. Når den er `dispatched`, er kittet blevet pakket og mærket af distributionspartneren, og annullering returnerer `409` — det samme gør en ordre, der er `activated`.

Hvis kittet allerede er bestilt hos distributionspartneren, annullerer vi det der, før vi annullerer dit, og kaldet fejler, hvis de ikke vil tage det tilbage: `409`, når kittet allerede er pakket og mærket, og `502`, når distributionspartneren afviste annulleringen eller ikke kunne kontaktes. Ved alle fejl **ændres intet** — ordren forbliver aktiv, og en `502` kan trygt prøves igen.

Annullering af en ordre, der allerede er `cancelled`, returnerer `200` med den pågældende ordre, uanset hvilken status den blev annulleret fra. Svaret indeholder `Idempotent-Replayed: true`, så du kan skelne en gentagelse fra det kald, der udførte handlingen. Se [Idempotens](https://docs.anivahealth.com/da/concepts/idempotency.md).

Kræver scopet `home_kit_orders_manage`.

## Forespørgsel

### Stiparametre

**id** `string` *required*

Unikt id (UUID) for den hjemmetestkitordre, der skal annulleres.

## Svar

Ved succes returnerer API'et `200 OK` med den annullerede hjemmetestkitordre og dens indlejrede profil. En ordre, der allerede var annulleret, returnerer den samme `200`.

**id** `string` *required*

Unikt id (UUID) for hjemmetestkitordren.

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

UUID for den profil, som denne hjemmetestkitordre tilhører.

**status** `string` *required*

Status for hjemmetestkitordren. Vil være `cancelled` efter en vellykket annullering.

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

Adressen, som kittet skal sendes til — i en af to former: enten `{ location_id }`, der henviser til en kendt testlokation, eller de direkte adressefelter (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` er valgfri — samme feltnavne som i locations-API'et). Angiv præcis én — enten en lokationsreference eller en direkte adresse, ikke begge dele.

**leveringsadresse**

> [tab] Lokationsreference
>
> **location\_id** `string` *required*
>
> UUID for den testlokation, som kittet sendes til.

> [tab] Direkte adresse
>
> **name** `string` *required*
>
> Navn på modtager, virksomhed eller lokation.
>
> **company\_name** `string`
>
> Virksomhed, der opbevarer pakken for modtageren — en `c/o`-part eller en afdeling.
>
> **street** `string` *required*
>
> Vejnavn uden husnummer (f.eks. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Husnummer (f.eks. `118` eller `12a`).
>
> **address\_line\_2** `string`
>
> Bygning, indgang eller etage.
>
> **city** `string` *required*
>
> **state** `string`
>
> Delstat eller provins. Valgfrit.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2-kode (to bogstaver, f.eks. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Laboratoriets prøvekode, som resultaterne rapporteres under — trykt på det fysiske kit, og det,
patienten aflæser på æsken som aktiveringskode. `null`, indtil kittet er pakket.
Skrivebeskyttet.

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

Prøvetagningstidspunkt rapporteret via [Aktivér](https://docs.anivahealth.com/da/api/home-kit-orders/activate-home-kit.md) — hvornår
patienten tog sin prøve. `null`, indtil kittet er aktiveret.

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

Den hjemmetestkitordre, som denne erstatter, når der er tale om et erstatningskit. `null` på en normal ordre. Se
[Opret hjemmetestkitordre](https://docs.anivahealth.com/da/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Årsagen til, at erstatningen blev sendt. `null` på en normal ordre.

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

Adresser med små bogstaver, som hver modtager én e-mail, når alle laboratorieresultater er endelige. Tom, når funktionen er slået fra. Se
[E-mails når resultater er klar](https://docs.anivahealth.com/da/concepts/results.md#e-mails-nar-resultater-er-klar).

**metadata** `object` *required*

Partnerdefinerede nøgle/værdi-par, der returneres uændret. Altid til stede — `{}` når ikke angivet.

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

ISO 8601-tidsstempel for, hvornår hjemmetestkitordren blev oprettet.

**updated\_at** `string`

ISO 8601-tidsstempel for den seneste opdatering. Kan være `null`.

**profile** `object` *required*

Patientprofilen, der er knyttet til denne hjemmetestkitordre.

**Profil**

**id** `string`

Unikt id for profilen (UUID).

**handle** `string`

Profil-handle eller brugernavn. Kan være `null`.

**first\_name** `string`

Fornavn. Kan være `null`.

**last\_name** `string`

Efternavn. Kan være `null`.

**email** `string`

E-mailadresse. Kan være `null`.

**phone** `string`

Telefonnummer i E.164-format. Kan være `null`.

**sex** `integer`

Biologisk køn efter ISO/IEC 5218. Kan være `null`.

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

Fødselsdato i formatet `YYYY-MM-DD`. Kan være `null`.

**height** `number`

Højde i centimeter. Kan være `null`.

**weight** `number`

Vægt i kilogram. Kan være `null`.

**language** `string`

Foretrukket sprog: en af de 32 koder i [Opret profil](https://docs.anivahealth.com/da/api/profiles/create-profile.md).

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

Om denne profil modtager transaktionelle (programmatiske) e-mails. Kan være `null`.

**created\_at** `string`

ISO 8601-tidsstempel for, hvornår profilen blev oprettet.

**updated\_at** `string`

ISO 8601-tidsstempel for den seneste opdatering af profilen. Kan være `null`.

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

Det panel, der var tilknyttet denne hjemmetestkitordre før annulleringen — altid præcis ét (et
hjemmetestkit svarer 1:1 til et fysisk kitprodukt). Slå paneldetaljer (navn, biomarkører) op via
[Vis paneler](https://docs.anivahealth.com/da/api/panels/list-panels.md).

**Felter for tilknyttet panel**

**panel\_id** `string`

Panelets UUID — slå op i [Vis paneler](https://docs.anivahealth.com/da/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601-tidsstempel for, hvornår panelet første gang blev tilknyttet denne hjemmetestkitordre.

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

Enkeltstående biomarkører, der var tilknyttet denne hjemmetestkitordre før annulleringen. Slå
hvert `biomarker_id` op i [Vis biomarkører](https://docs.anivahealth.com/da/api/biomarkers/list-biomarkers.md) med `home_kit=true` for at få visningsdata.

**Felter for individuelle biomarkører**

**biomarker\_id** `integer`

Biomarkør-id — slå op i
[Vis biomarkører](https://docs.anivahealth.com/da/api/biomarkers/list-biomarkers.md) med `home_kit=true`.

**added\_at** `string`

ISO 8601-tidsstempel for, hvornår biomarkøren første gang blev tilknyttet denne hjemmetestkitordre.

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

Pakker, der var knyttet til denne hjemmetestkitordre før annulleringen, med den ældste tilknytning først. Hent de
komplette pakkeoplysninger med [Vis forsendelser](https://docs.anivahealth.com/da/api/shipments/list-shipments.md) og `?home_kit_order_id=`.

**Felter for forsendelsestilknytning**

**id** `string`

Forsendelsesreference — slå op via [Hent forsendelse](https://docs.anivahealth.com/da/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601-tidsstempel for, hvornår forsendelsen blev knyttet til denne hjemmetestkitordre.

## Fejlsvar

| Status | Beskrivelse |
| - | - |
| `400` | Ugyldigt id-format — den angivne værdi er ikke et gyldigt UUID. |
| `403` | Forbudt — din API-nøgle har ikke adgang til denne handling, eller hjemmetestkitordren ligger uden for dine rettigheder. |
| `404` | Hjemmetestkitordre ikke fundet. |
| `409` | Konflikt — ordren er ikke længere `pending` (afsendt eller aktiveret), eller kittet er allerede blevet pakket og mærket af distributionspartneren. |
| `500` | Intern serverfejl. |
| `502` | Distributionspartneren afviste annulleringen (inkluderer deres begrundelse) eller kunne ikke kontaktes. Intet blev ændret; ordren er stadig aktiv. |

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