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

# Kanseller bestilling av hjemmetestsett

> Kanseller et postsendt hjemmetestsett

Kanseller en bestilling av hjemmetestsett ved å sette statusen til `cancelled`. Den kansellerte bestillingen av hjemmetestsett returneres i svaret.

Bare en bestilling med status `pending` kan kanselleres. Når den har status `dispatched`, er settet pakket og merket av logistikkpartneren, og kansellering returnerer `409` – det samme gjelder en bestilling med status `activated`.

Hvis settet allerede er bestilt hos logistikkpartneren, kansellerer vi det der før vi kansellerer bestillingen din, og kallet feiler hvis de ikke vil ta det tilbake: `409` når settet allerede er pakket og merket, `502` når logistikkpartneren avviste kanselleringen eller ikke kunne nås. Ved enhver feil **endres ingenting** – bestillingen forblir aktiv, og det er trygt å prøve på nytt ved `502`.

Kansellering av en bestilling som allerede har status `cancelled`, returnerer `200` med den bestillingen, uansett hvilken status den ble kansellert fra. Svaret inneholder `Idempotent-Replayed: true`, slik at du kan skille et gjentatt kall fra kallet som utførte endringen. Se [Idempotens](https://docs.anivahealth.com/no/concepts/idempotency.md).

Krever scope-et `home_kit_orders_manage`.

## Forespørsel

### Stiparametere

**id** `string` *required*

Unik identifikator (UUID) for bestillingen av hjemmetestsett som skal kanselleres.

## Respons

Ved suksess returnerer API-et `200 OK` med den kansellerte bestillingen av hjemmetestsett og den innebygde profilen. En bestilling som allerede var kansellert, returnerer samme `200`.

**id** `string` *required*

Unik identifikator (UUID) for bestillingen av hjemmetestsett.

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

UUID for profilen denne bestillingen av hjemmetestsett tilhører.

**status** `string` *required*

Status for bestillingen av hjemmetestsett. Blir `cancelled` etter en vellykket kansellering.

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

Adressen settet skal sendes til – én av to former: enten `{ location_id }` som refererer til et kjent teststed, eller direkte adressefelt (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` er valgfrie – samme struktur som i lokasjons-API-et). Oppgi nøyaktig én – en stedsreferanse eller en direkte adresse, ikke begge.

**leveringsadresse**

> [tab] Stedsreferanse
>
> **location\_id** `string` *required*
>
> UUID for teststedet settet sendes til.

> [tab] Direkte adresse
>
> **name** `string` *required*
>
> Navn på mottaker, bedrift eller sted.
>
> **company\_name** `string`
>
> Bedrift som tar imot pakken for mottakeren – en `c/o`-mottaker eller en avdeling.
>
> **street** `string` *required*
>
> Gatenavn, uten husnummer (f.eks. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Husnummer (f.eks. `118` eller `12a`).
>
> **address\_line\_2** `string`
>
> Bygning, inngang eller etasje.
>
> **city** `string` *required*
>
> **state** `string`
>
> Delstat eller provins. Valgfritt.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2-kode (to bokstaver, f.eks. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Prøvekode hos laboratoriet som resultatene rapporteres under – trykt på det fysiske settet, og det
pasienten leser av esken som aktiveringskode. `null` til settet er pakket.
Skrivebeskyttet.

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

Prøvetakingstidspunkt rapportert via [Aktiver](https://docs.anivahealth.com/no/api/home-kit-orders/activate-home-kit.md) – når
pasienten tok prøven sin. `null` til settet er aktivert.

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

Bestillingen av hjemmetestsett som denne erstatter, når det er et erstatningssett. `null` ved en vanlig bestilling. Se
[Opprett bestilling av hjemmetestsett](https://docs.anivahealth.com/no/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Hvorfor erstatningen ble sendt. `null` ved en vanlig bestilling.

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

Adresser som hver får én e-post når alle labresultater er endelige, i små bokstaver. Tom når den er slått av. Se
[E-poster om klare resultater](https://docs.anivahealth.com/no/concepts/results.md#e-poster-nar-resultater-er-klare).

**metadata** `object` *required*

Partnerdefinerte nøkkel/verdi-par, returnert uendret. Alltid med – `{}` når ikke angitt.

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

ISO 8601-tidsstempel for når bestillingen av hjemmetestsett ble opprettet.

**updated\_at** `string`

ISO 8601-tidsstempel for siste oppdatering. Kan være `null`.

**profile** `object` *required*

Pasientprofilen som er knyttet til denne bestillingen av hjemmetestsett.

**profil**

**id** `string`

Unik profilidentifikator (UUID).

**handle** `string`

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

**first\_name** `string`

Fornavn. Kan være `null`.

**last\_name** `string`

Etternavn. Kan være `null`.

**email** `string`

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

**phone** `string`

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

**sex** `integer`

Biologisk kjønn etter ISO/IEC 5218. Kan være `null`.

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

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

**height** `number`

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

**weight** `number`

Vekt i kilogram. Kan være `null`.

**language** `string`

Foretrukket språk: en av de 32 kodene i [Opprett profil](https://docs.anivahealth.com/no/api/profiles/create-profile.md).

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

Om denne profilen mottar transaksjonelle (programmatiske) e-poster. Kan være `null`.

**created\_at** `string`

ISO 8601-tidsstempel for når profilen ble opprettet.

**updated\_at** `string`

ISO 8601-tidsstempel for siste profiloppdatering. Kan være `null`.

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

Panelet som var knyttet til denne bestillingen av hjemmetestsett før kansellering – alltid nøyaktig ett (et
hjemmetestsett tilsvarer 1:1 et fysisk settprodukt). Slå opp paneldetaljer (navn, biomarkører) via
[Vis paneler](https://docs.anivahealth.com/no/api/panels/list-panels.md).

**Felter for tilknyttet panel**

**panel\_id** `string`

Panel-UUID – kryssreferanse mot [Vis paneler](https://docs.anivahealth.com/no/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601-tidsstempel for når panelet først ble knyttet til denne bestillingen av hjemmetestsett.

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

Enkeltstående biomarkører som var knyttet til denne bestillingen av hjemmetestsett før kansellering. Kryssreferer
hver `biomarker_id` mot [Vis biomarkører](https://docs.anivahealth.com/no/api/biomarkers/list-biomarkers.md) med `home_kit=true` for visningsdata.

**Felter for enkeltstående biomarkør**

**biomarker\_id** `integer`

Biomarkør-ID – kryssreferanse mot
[Vis biomarkører](https://docs.anivahealth.com/no/api/biomarkers/list-biomarkers.md) med `home_kit=true`.

**added\_at** `string`

ISO 8601-tidsstempel for når biomarkøren først ble knyttet til denne bestillingen av hjemmetestsett.

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

Pakker som var koblet til denne bestillingen av hjemmetestsett før kansellering, eldste kobling først. Hent
fullstendig pakkeinformasjon med [Vis forsendelser](https://docs.anivahealth.com/no/api/shipments/list-shipments.md) og `?home_kit_order_id=`.

**Felter for forsendelseskobling**

**id** `string`

Forsendelsesreferanse – kryssreferanse mot [Hent forsendelse](https://docs.anivahealth.com/no/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601-tidsstempel for når forsendelsen ble koblet til denne bestillingen av hjemmetestsett.

## Feilresponser

| Status | Beskrivelse |
| - | - |
| `400` | Ugyldig ID-format – verdien som ble oppgitt er ikke en gyldig UUID. |
| `403` | Ingen tilgang – API-nøkkelen din har ikke tilgang til denne operasjonen, eller bestillingen av hjemmetestsett ligger utenfor tilgangsområdet ditt. |
| `404` | Fant ikke bestillingen av hjemmetestsett. |
| `409` | Konflikt – bestillingen har ikke lenger status `pending` (sendt eller aktivert), eller settet er allerede pakket og merket av logistikkpartneren. |
| `500` | Intern serverfeil. |
| `502` | Logistikkpartneren avviste kanselleringen (inkluderer begrunnelsen deres) eller kunne ikke nås. Ingenting ble endret; bestillingen er fortsatt 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.