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

# Uppdatera beställning av hemtestkit

> Ändra ett självtestkit med hemleverans

Uppdatera leveransadress, panel, metadata eller e-postadresser för klara resultat för en hemtestkitbeställning. Ta bara med de fält du vill ändra.

Leveransadressen och panelen kan bara ändras medan beställningen är `pending`, eftersom det fysiska kitet skickas vid utskick. `metadata` är din egen bokföring och går att skriva till under hela beställningens livstid.

Det finns inga endpoints för att lägga till eller ta bort paneler: ett hemtestkit har exakt en panel (det motsvarar 1:1 en fysisk kitprodukt), så den enda meningsfulla panelåtgärden är bytet du gör här.

Kräver scopet `home_kit_orders_manage`.

## Förfrågan

### Sökvägsparametrar

**id** `string` *required*

Unik identifierare (UUID) för hemtestkitbeställningen som ska uppdateras.

### Body-parametrar

Alla body-parametrar är valfria – ta bara med de fält du vill ändra.

**delivery\_address** `object`

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

**leveransadress**

> [tab] Referera till en plats
>
> **location\_id** `string` *required*
>
> UUID för en känd provtagningsplats som kitet ska skickas till. Stäm av mot [Lista
> platser](https://docs.anivahealth.com/sv/api/locations/list-locations.md).

> [tab] Direkt 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, port eller våning.
>
> **city** `string` *required*
>
> **state** `string`
>
> Delstat eller provins. Valfritt.
>
> **postal\_code** `string` *required*
>
> Postnummer. En tysk adress (`country_code` `DE`) kräver exakt 5 siffror, t.ex. `10117`.
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2-kod (två bokstäver, t.ex. `DE`). Gemener accepteras och sparas som
> versaler.
>
> **phone** `string`
>
> Mottagarens telefonnummer med landskod (t.ex. `+4791234567`). Transportören använder det för
> att meddela mottagaren om paketet, till exempel att det väntar på ett ombud. Utelämna
> fältet så får transportören inget telefonnummer.
>
> **email** `string`
>
> Mottagarens e-postadress. Transportören använder den på samma sätt som `phone`. Utelämna
> fältet så får transportören ingen e-postadress.

> [!NOTE]
>
> **Packstation eller Postfiliale (endast Tyskland):** sätt `street` till `Packstation` eller
> `Postfiliale`, `house_number` till det tresiffriga stationsnumret och `address_line_2` till
> mottagarens DHL Postnummer (6–10 siffror, mellanslag tillåtna). Utan Postnummer kan paketet inte
> bokas. Postfach stöds inte.

**panel\_id** `string`

UUID för panelen som ska kopplas i stället för den nuvarande — med exakt en panel per kit är ett
byte den enda meningsfulla åtgärden. Gäller bara medan beställningen är `pending`, och bara till
en panel som Aniva har konfigurerat med en kitprodukt för leverans (annars `422`); ett byte till
den redan kopplade panelen gör ingenting.

**metadata** `object`

Dina egna nyckel/värde-par. **Slås ihop** med befintlig metadata i stället för att ersätta den:
nycklar du utelämnar bevaras, en nyckel som skickas med värdet `null` tas bort och ett tomt
objekt `{}` rensar allt. Gränserna motsvarar
[Skapa hemtestkitbeställning](https://docs.anivahealth.com/sv/api/home-kit-orders/create-home-kit.md) och valideringen är
allt-eller-inget — om någon nyckel avvisas skrivs ingenting. Lägg aldrig personuppgifter eller
kliniska data i `metadata` — det behandlas inte som patientdata.

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

Ersätter listan med upp till 5 adresser som får ett mejl vardera när alla labbresultat är
slutgiltiga. Skicka `[]` för att stänga av mejlen. Kan redigeras i alla statusar utom `cancelled`.
Din nyckel behöver `results_view`-åtkomst till patienten, annars returneras `403`. Se
[Mejl när resultat är klara](https://docs.anivahealth.com/sv/concepts/results.md#mejl-naer-resultat-aer-klara).

## Svar

Vid framgång returnerar API:et `200 OK` med den uppdaterade hemtestkitbeställningen och dess inbäddade profil.

**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*

Aktuell status för hemtestkitbeställningen. Ett av värdena `pending`, `dispatched`, `activated` eller `cancelled`.

**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 hör till den här hemtestkitbeställningen — alltid exakt en (ett hemtestkit motsvarar
1:1 en fysisk kitprodukt), och byts ut på plats när du skickar `panel_id`. Slå upp paneldetaljer
(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 är kopplade till denna beställning av hemtestkit utanför en panel. 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 kopplade till denna beställning av hemtestkit, äldsta kopplingen först – vanligtvis kitet till patienten
och provet tillbaka till laboratoriet. Tom tills lagret skriver ut en fraktetikett. 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` | Valideringsfel — t.ex. ogiltigt UUID-format eller ett saknat fält i `delivery_address`. |
| `403` | Åtkomst nekad — din API-nyckel har inte åtkomst till den här åtgärden, hemtestkitbeställningen ligger utanför ditt behörighetsomfång eller så angav du `results_ready_emails` utan `results_view`-åtkomst till patienten. |
| `404` | Hemtestkitbeställningen hittades inte, eller så finns inte panelen för `panel_id`. |
| `409` | Konflikt — beställningen är inte längre `pending`; adress och panel kan bara ändras före utskick. |
| `409` | Konflikt — beställningen är ett ersättningskit, som behåller panelen från beställningen den ersätter. |
| `409` | Konflikt — beställningen är `cancelled` och du skickade `results_ready_emails`. |
| `422` | Panelen kan inte beställas som hemtestkit — ingen kitprodukt för leverans har konfigurerats. |
| `500` | Internt serverfel. |

```bash cURL theme={null}
curl --request PATCH \
  --url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "delivery_address": {
      "name": "Maria Schmidt",
      "street": "Unter den Linden",
      "house_number": "77",
      "postal_code": "10117",
      "city": "Berlin",
      "country_code": "DE",
      "phone": "+4930123456789",
      "email": "maria.schmidt@example.com"
    }
  }'
```

```json 200 theme={null}
{
  "id": "d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a",
  "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
  "status": "pending",
  "delivery_address": {
    "name": "Maria Schmidt",
    "street": "Unter den Linden",
    "house_number": "77",
    "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-01T13:10: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": { "your_order_ref": "ORD-10482" },
  "replaces_home_kit_order_id": null,
  "replacement_reason": null,
  "results_ready_emails": [],
  "lab_code": null,
  "activated_at": null,
  "shipments": []
}
```

```json 400 theme={null}
{
  "error": "delivery_address: Invalid input"
}
```

```json 409 theme={null}
{
  "error": "Panels and biomarkers can only be changed while the home kit order is pending. Once it is dispatched, activated, or cancelled its composition is locked."
}
```

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


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