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

# Avbryt beställning av hemtestkit

> Avbryt ett självtestkit med hemleverans

Avbryt en beställning av hemtestkit genom att sätta dess status till `cancelled`. Den avbrutna beställningen av hemtestkit returneras i svaret.

Endast en beställning med status `pending` kan avbrytas. När den har status `dispatched` har kitet packats och märkts av logistikpartnern, och en avbeställning returnerar `409` – precis som för en beställning med status `activated`.

Om kitet redan har beställts från logistikpartnern avbeställer vi det där innan vi avbryter din beställning, och anropet misslyckas om de inte tar tillbaka det: `409` när kitet redan är packat och märkt, `502` när logistikpartnern nekade avbeställningen eller inte kunde nås. Vid varje fel **ändras ingenting** – beställningen förblir aktiv, och det är säkert att försöka igen vid `502`.

Att avbryta en beställning som redan har status `cancelled` returnerar `200` med den beställningen, oavsett vilken status den avbröts från. Svaret innehåller `Idempotent-Replayed: true` så att du kan skilja en upprepning från anropet som utförde ändringen. Se [Idempotens](https://docs.anivahealth.com/sv/concepts/idempotency.md).

Kräver scopet `home_kit_orders_manage`.

## Förfrågan

### Sökvägsparametrar

**id** `string` *required*

Unik identifierare (UUID) för beställningen av hemtestkit som ska avbrytas.

## Svar

När anropet lyckas returnerar API:et `200 OK` med den avbrutna beställningen av hemtestkit och dess inbäddade profil. En beställning som redan var avbruten returnerar samma `200`.

**id** `string` *required*

Unik identifierare (UUID) för beställningen av hemtestkit.

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

UUID för profilen som den här beställningen av hemtestkit tillhör.

**status** `string` *required*

Status för beställningen av hemtestkit. Är `cancelled` efter en lyckad avbeställning.

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

Adressen som kitet ska skickas till – i ett av två format: antingen `{ location_id }` som refererar till en känd testplats, eller inline-adressfälten (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` är valfria – samma fältnamn som i locations-API:et). Ange exakt ett alternativ – en platsreferens eller en inline-adress, inte båda.

**leveransadress**

> [tab] Platsreferens
>
> **location\_id** `string` *required*
>
> UUID för testplatsen som kitet skickas till.

> [tab] Inline-adress
>
> **name** `string` *required*
>
> Mottagarens, företagets eller platsens namn.
>
> **company\_name** `string`
>
> Företag som tar emot paketet åt mottagaren – en `c/o`-mottagare eller en avdelning.
>
> **street** `string` *required*
>
> Gatunamn utan husnummer (t.ex. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Husnummer (t.ex. `118` eller `12a`).
>
> **address\_line\_2** `string`
>
> Byggnad, ingång eller våning.
>
> **city** `string` *required*
>
> **state** `string`
>
> Delstat eller provins. Valfritt.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2-kod (två bokstäver, t.ex. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Laboratoriets provkod som resultaten rapporteras under – tryckt på det fysiska kitet, och det som
patienten läser av från lådan som aktiveringskod. `null` tills kitet är packat.
Skrivskyddad.

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

Tidsstämpel för provtagning rapporterad via [Aktivera](https://docs.anivahealth.com/sv/api/home-kit-orders/activate-home-kit.md) –
när patienten tog sitt prov. `null` tills kitet är aktiverat.

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

Beställningen av hemtestkit som den här ersätter, när det rör sig om ett ersättningskit. `null`
för en vanlig beställning. Se [Skapa beställning av hemtestkit](https://docs.anivahealth.com/sv/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Anledningen till att ersättningen skickades. `null` för en vanlig beställning.

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

Adresser som var och en får ett mejl när alla labbresultat är slutgiltiga, i gemener. Tom när funktionen är avstängd. Se
[Mejl när resultat är klara](https://docs.anivahealth.com/sv/concepts/results.md#mejl-naer-resultat-aer-klara).

**metadata** `object` *required*

Partnerdefinierade nyckel/värde-par som returneras exakt som de skickades. Finns alltid med – `{}`
när inga värden angetts.

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

ISO 8601-tidsstämpel för när beställningen av hemtestkit skapades.

**updated\_at** `string`

ISO 8601-tidsstämpel för den senaste uppdateringen. Kan vara `null`.

**profile** `object` *required*

Patientprofilen som är kopplad till den här beställningen av hemtestkit.

**profil**

**id** `string`

Unik identifierare för profilen (UUID).

**handle** `string`

Profil-handle eller användarnamn. Kan vara `null`.

**first\_name** `string`

Förnamn. Kan vara `null`.

**last\_name** `string`

Efternamn. Kan vara `null`.

**email** `string`

E-postadress. Kan vara `null`.

**phone** `string`

Telefonnummer i E.164-format. Kan vara `null`.

**sex** `integer`

Biologiskt kön enligt ISO/IEC 5218. Kan vara `null`.

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

Födelsedatum i formatet `YYYY-MM-DD`. Kan vara `null`.

**height** `number`

Längd i centimeter. Kan vara `null`.

**weight** `number`

Vikt i kilogram. Kan vara `null`.

**language** `string`

Föredraget språk: en av de 32 koderna i [Skapa profil](https://docs.anivahealth.com/sv/api/profiles/create-profile.md).

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

Om profilen tar emot transaktionella (programmatiska) mejl. Kan vara `null`.

**created\_at** `string`

ISO 8601-tidsstämpel för när profilen skapades.

**updated\_at** `string`

ISO 8601-tidsstämpel för den senaste uppdateringen av profilen. Kan vara `null`.

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

Panelen som var kopplad till den här beställningen av hemtestkit innan den avbröts – alltid exakt
en (ett hemtestkit motsvarar 1:1 en fysisk kitprodukt). Hämta panelinformation (namn, biomarkörer)
via [Lista paneler](https://docs.anivahealth.com/sv/api/panels/list-panels.md).

**Fält för kopplad panel**

**panel\_id** `string`

Panel-UUID – stäm av mot [Lista paneler](https://docs.anivahealth.com/sv/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601-tidsstämpel för när panelen först kopplades till den här beställningen av hemtestkit.

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

Enskilda biomarkörer som var kopplade till den här beställningen av hemtestkit innan den avbröts.
Stäm av varje `biomarker_id` mot [Lista biomarkörer](https://docs.anivahealth.com/sv/api/biomarkers/list-biomarkers.md) med `home_kit=true` för visningsdata.

**Fält för enskild biomarkör**

**biomarker\_id** `integer`

Biomarköridentifierare – stäm av mot
[Lista biomarkörer](https://docs.anivahealth.com/sv/api/biomarkers/list-biomarkers.md) med `home_kit=true`.

**added\_at** `string`

ISO 8601-tidsstämpel för när biomarkören först kopplades till den här beställningen av hemtestkit.

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

Paket som var länkade till den här beställningen av hemtestkit innan den avbröts, med äldsta
kopplingen först. Läs fullständig paketinformation med [Lista försändelser](https://docs.anivahealth.com/sv/api/shipments/list-shipments.md) och `?home_kit_order_id=`.

**Fält för försändelselänk**

**id** `string`

Försändelsereferens – stäm av mot [Hämta försändelse](https://docs.anivahealth.com/sv/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601-tidsstämpel för när försändelsen länkades till den här beställningen av hemtestkit.

## Felsvar

| Status | Beskrivning |
| - | - |
| `400` | Ogiltigt ID-format – det angivna värdet är inte en giltig UUID. |
| `403` | Åtkomst nekad – din API-nyckel har inte åtkomst till den här åtgärden, eller så ligger beställningen av hemtestkit utanför ditt behörighetsområde. |
| `404` | Beställningen av hemtestkit hittades inte. |
| `409` | Konflikt – beställningen har inte längre status `pending` (skickad eller aktiverad), eller så har kitet redan packats och märkts av logistikpartnern. |
| `500` | Internt serverfel. |
| `502` | Logistikpartnern nekade avbeställningen (inkluderar deras orsak) eller kunde inte nås. Ingenting ändrades; beställningen är fortfarande 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.