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

# Päivitä kotitestipakkauksen tilaus

> Muokkaa kotiin postitettavaa kotitestipakkausta

Päivitä kotitestipakkaustilauksen toimitusosoite, paneeli, metatiedot tai tulosilmoitussähköpostit. Sisällytä vain kentät, joita haluat muuttaa.

Toimitusosoitetta ja paneelia voi muuttaa vain tilauksen ollessa tilassa `pending`, koska fyysinen pakkaus lähetetään lähetysvaiheessa. `metadata` on omaa kirjanpitoasi ja pysyy muokattavana koko tilauksen elinkaaren ajan.

Paneelin lisäämiseen tai poistamiseen ei ole päätepisteitä: kotitestipakkauksessa on aina tasan yksi paneeli (se vastaa 1:1 fyysistä pakkaustuotetta), joten ainoa mielekäs paneelitoiminto on tässä tehtävä vaihto.

Vaatii `home_kit_orders_manage`-laajuuden.

## Pyyntö

### Polkuparametrit

**id** `string` *required*

Päivitettävän kotitestipakkaustilauksen yksilöllinen tunniste (UUID).

### Runkoparametrit

Kaikki runkoparametrit ovat valinnaisia — sisällytä vain kentät, joita haluat muuttaa.

**delivery\_address** `object`

Osoite, johon pakkaus postitetaan — toinen kahdesta muodosta: joko `{ location_id }`, joka viittaa tunnettuun testitoimipisteeseen, tai suorat osoitekentät (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` valinnaisia — sama sanasto kuin locations-API:ssa). Anna täsmälleen toinen — toimipisteviittaus tai suora osoite, ei molempia.

**toimitusosoite**

> [tab] Viittaa sijaintiin
>
> **location\_id** `string` *required*
>
> Tunnetun testauspaikan UUID, johon pakkaus lähetetään. Tarkista vastaavuus kutsulla [Listaa
> sijainnit](https://docs.anivahealth.com/fi/api/locations/list-locations.md).

> [tab] Suora osoite
>
> **name** `string` *required*
>
> Vastaanottajan, yrityksen tai sijainnin nimi.
>
> **company\_name** `string`
>
> Yritys, joka ottaa paketin vastaan vastaanottajan puolesta — `c/o`-taho tai osasto.
>
> **street** `string` *required*
>
> Kadunnimi ilman talonnumeroa (esim. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Talonnumero (esim. `118` tai `12a`).
>
> **address\_line\_2** `string`
>
> Rakennus, sisäänkäynti tai kerros.
>
> **city** `string` *required*
>
> **state** `string`
>
> Osavaltio tai maakunta. Valinnainen.
>
> **postal\_code** `string` *required*
>
> Postinumero. Saksalainen osoite (`country_code` `DE`) vaatii tasan 5 numeroa, esim. `10117`.
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2 -koodi (kaksi kirjainta, esim. `DE`). Pienet kirjaimet hyväksytään ja
> tallennetaan isoina.
>
> **phone** `string`
>
> Vastaanottajan puhelinnumero maatunnuksella (esim. `+4791234567`). Kuljetusyhtiö ilmoittaa
> sen avulla vastaanottajalle paketista, esimerkiksi että se odottaa noutopisteessä. Jos jätät
> kentän pois, kuljetusyhtiö ei saa puhelinnumeroa.
>
> **email** `string`
>
> Vastaanottajan sähköpostiosoite. Kuljetusyhtiö käyttää sitä samoin kuin kenttää `phone`. Jos
> jätät kentän pois, kuljetusyhtiö ei saa sähköpostiosoitetta.

> [!NOTE]
>
> **Packstation tai Postfiliale (vain Saksa):** aseta `street`-kenttään `Packstation` tai
> `Postfiliale`, `house_number`-kenttään kolminumeroinen aseman numero ja `address_line_2`-kenttään
> vastaanottajan DHL Postnummer (6–10 numeroa, välilyönnit sallittu). Ilman Postnummer-tunnusta
> pakettia ei voi varata. Postfach ei ole tuettu.

**panel\_id** `string`

Nykyisen tilalle liitettävän paneelin UUID — koska pakkauksessa on tasan yksi paneeli, vaihto
on ainoa mielekäs toiminto. Sallittu vain tilauksen ollessa tilassa `pending`, ja vain paneeliin,
jolle Aniva on määrittänyt toimitettavan pakkaustuotteen (muuten `422`); vaihto jo liitettyyn
paneeliin ei tee mitään.

**metadata** `object`

Omat avain-arvoparisi. **Yhdistetään** olemassa oleviin metatietoihin korvaamisen sijaan: pois
jättämäsi avaimet säilyvät, `null`-arvolla lähetetty avain poistetaan ja tyhjä objekti `{}`
tyhjentää kaiken. Rajoitukset vastaavat kohtaa [Luo kotitestipakkaustilaus](https://docs.anivahealth.com/fi/api/home-kit-orders/create-home-kit.md),
ja validointi on kaikki tai ei mitään — jos yksikin avain hylätään, mitään ei tallenneta. Älä koskaan
laita henkilö- tai kliinisiä tietoja kenttään `metadata` — sitä ei käsitellä potilastietona.

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

Korvaa enintään 5 osoitteen luettelon, joihin kuhunkin lähetetään yksi sähköposti, kun kaikki
laboratoriotulokset ovat valmiit. Lähetä `[]` poistaaksesi sähköpostit käytöstä. Muokattavissa
kaikissa tiloissa paitsi `cancelled`. Avaimesi tarvitsee `results_view`-oikeuden potilaaseen,
muuten palautetaan `403`. Katso
[Tulosilmoitussähköpostit](https://docs.anivahealth.com/fi/concepts/results.md#saehkoepostit-tulosten-valmistumisesta).

## Vastaus

Onnistuessaan API palauttaa `200 OK` sekä päivitetyn kotitestipakkaustilauksen ja siihen sisältyvän profiilin.

**id** `string` *required*

Kotitestipakkauksen tilauksen yksilöllinen tunniste (UUID).

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

Sen profiilin UUID, jolle tämä kotitestipakkauksen tilaus kuuluu.

**status** `string` *required*

Kotitestipakkaustilauksen nykyinen tila. Yksi arvoista `pending`, `dispatched`, `activated` tai `cancelled`.

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

Osoite, johon pakkaus postitetaan — toinen kahdesta muodosta: joko `{ location_id }`, joka viittaa tunnettuun testipaikkaan, tai suorat osoitekentät (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` valinnaisia — sama sanasto kuin locations-API:ssa). Anna täsmälleen toinen — sijaintiviittaus tai suora osoite, ei molempia.

**toimitusosoite**

> [tab] Sijaintiviittaus
>
> **location\_id** `string` *required*
>
> Sen testipaikan UUID, johon pakkaus lähetetään.

> [tab] Suora osoite
>
> **name** `string` *required*
>
> Vastaanottajan, yrityksen tai sijainnin nimi.
>
> **company\_name** `string`
>
> Yritys, joka ottaa paketin vastaan vastaanottajan puolesta — `c/o`-taho tai osasto.
>
> **street** `string` *required*
>
> Kadunnimi ilman talon numeroa (esim. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Talon numero (esim. `118` tai `12a`).
>
> **address\_line\_2** `string`
>
> Rakennus, sisäänkäynti tai kerros.
>
> **city** `string` *required*
>
> **state** `string`
>
> Osavaltio tai maakunta. Valinnainen.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2 -koodi (kaksi kirjainta, esim. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Laboratorion näytekoodi, jonka alla tulokset raportoidaan — painettu fyysiseen pakkaukseen, ja sen
potilas lukee rasiasta aktivointikoodina. `null`, kunnes pakkaus on pakattu.
Vain luku.

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

[Aktivoi](https://docs.anivahealth.com/fi/api/home-kit-orders/activate-home-kit.md)-päätepisteen kautta ilmoitettu näytteenoton aikaleima — ajankohta, jolloin
potilas otti näytteensä. `null`, kunnes pakkaus on aktivoitu.

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

Kotitestipakkauksen tilaus, jonka tämä tilaus korvaa, kun kyseessä on korvaava pakkaus. `null` normaalissa tilauksessa. Katso
[Luo kotitestipakkauksen tilaus](https://docs.anivahealth.com/fi/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Syy korvaavan pakkauksen lähettämiselle. `null` normaalissa tilauksessa.

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

Osoitteet pienillä kirjaimilla, joista jokainen saa yhden sähköpostin kaikkien laboratoriotulosten
valmistuttua. Tyhjä, kun toiminto on pois päältä. Katso
[Tulokset valmiit -sähköpostit](https://docs.anivahealth.com/fi/concepts/results.md#saehkoepostit-tulosten-valmistumisesta).

**metadata** `object` *required*

Kumppanin määrittämät avain-arvoparit, jotka palautetaan sellaisinaan. Aina mukana — `{}` kun arvoja ei ole asetettu.

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

ISO 8601 -aikaleima siitä, milloin kotitestipakkauksen tilaus luotiin.

**updated\_at** `string`

ISO 8601 -aikaleima viimeisimmästä päivityksestä. Voi olla `null`.

**profile** `object` *required*

Tähän kotitestipakkauksen tilaukseen liittyvä potilasprofiili.

**profiili**

**id** `string`

Profiilin yksilöllinen tunniste (UUID).

**handle** `string`

Profiilin nimimerkki tai käyttäjätunnus. Voi olla `null`.

**first\_name** `string`

Etunimi. Voi olla `null`.

**last\_name** `string`

Sukunimi. Voi olla `null`.

**email** `string`

Sähköpostiosoite. Voi olla `null`.

**phone** `string`

Puhelinnumero E.164-muodossa. Voi olla `null`.

**sex** `integer`

Biologinen sukupuoli standardin ISO/IEC 5218 mukaisesti. Voi olla `null`.

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

Syntymäaika muodossa `YYYY-MM-DD`. Voi olla `null`.

**height** `number`

Pituus senttimetreinä. Voi olla `null`.

**weight** `number`

Paino kilogrammoina. Voi olla `null`.

**language** `string`

Ensisijainen kieli: yksi 32 koodista sivulla [Luo profiili](https://docs.anivahealth.com/fi/api/profiles/create-profile.md).

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

Saako tämä profiili tapahtumapohjaisia (automaattisia) sähköposteja. Voi olla `null`.

**created\_at** `string`

ISO 8601 -aikaleima profiilin luontihetkestä.

**updated\_at** `string`

ISO 8601 -aikaleima profiilin viimeisimmästä päivityksestä. Voi olla `null`.

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

Tähän kotitestipakkaustilaukseen liitetty paneeli — aina tasan yksi (kotitestipakkaus vastaa 1:1
fyysistä pakkaustuotetta), joka korvataan paikallaan, kun välität parametrin `panel_id`. Hae paneelin
tiedot (nimi, biomarkkerit) päätepisteestä [Listaa paneelit](https://docs.anivahealth.com/fi/api/panels/list-panels.md).

**Paneelin liittämiskentät**

**panel\_id** `string`

Paneelin UUID — tarkista vastaavuus [Listaa paneelit](https://docs.anivahealth.com/fi/api/panels/list-panels.md) -päätepisteestä.

**added\_at** `string`

ISO 8601 -aikaleima siitä, milloin paneeli liitettiin ensimmäisen kerran tähän kotitestipakkauksen tilaukseen.

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

Tähän kotitestipakkaustilaukseen paneelin ulkopuolelta liitetyt yksittäiset biomarkkerit. Tarkista kunkin
`biomarker_id`-tunnisteen näyttötiedot päätepisteestä [Listaa biomarkkerit](https://docs.anivahealth.com/fi/api/biomarkers/list-biomarkers.md) parametrilla `home_kit=true`.

**Yksittäisen biomarkkerin kentät**

**biomarker\_id** `integer`

Biomarkkerin tunniste — tarkista vastaavuus
[Listaa biomarkkerit](https://docs.anivahealth.com/fi/api/biomarkers/list-biomarkers.md) -päätepisteestä parametrilla `home_kit=true`.

**added\_at** `string`

ISO 8601 -aikaleima siitä, milloin biomarkkeri liitettiin ensimmäisen kerran tähän kotitestipakkauksen tilaukseen.

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

Tähän kotitestipakkaustilaukseen linkitetyt paketit vanhin linkki ensin — yleensä pakkaus potilaalle
ja näyte takaisin laboratorioon. Tyhjä, kunnes toimituskeskus tulostaa osoitekortin. Hae
pakettien kaikki tiedot päätepisteestä [Listaa lähetykset](https://docs.anivahealth.com/fi/api/shipments/list-shipments.md) parametrilla `?home_kit_order_id=`.

**Lähetyslinkityksen kentät**

**id** `string`

Lähetysviite — tarkista vastaavuus [Hae lähetys](https://docs.anivahealth.com/fi/api/shipments/get-shipment.md) -päätepisteestä.

**added\_at** `string`

ISO 8601 -aikaleima siitä, milloin lähetys linkitettiin tähän kotitestipakkauksen tilaukseen.

## Virhevastaukset

| Tila | Kuvaus |
| - | - |
| `400` | Validointivirhe — esim. virheellinen UUID-muoto tai puuttuva `delivery_address`-kenttä. |
| `403` | Kielletty — API-avaimellasi ei ole oikeutta tähän toimintoon, kotitestipakkaustilaus ei kuulu käyttöoikeuksiisi tai asetit kentän `results_ready_emails` ilman `results_view`-oikeutta potilaaseen. |
| `404` | Kotitestipakkaustilausta ei löytynyt tai `panel_id`-paneelia ei ole olemassa. |
| `409` | Ristiriita — tilaus ei ole enää tilassa `pending`; osoitetta ja paneelia voi muuttaa vain ennen lähetystä. |
| `409` | Ristiriita — tilaus on korvaava pakkaus, joka säilyttää korvaamansa tilauksen paneelin. |
| `409` | Ristiriita — tilaus on tilassa `cancelled` ja lähetit kentän `results_ready_emails`. |
| `422` | Paneelia ei voi tilata kotitestipakkauksena — toimitettavaa pakkaustuotetta ei ole määritetty. |
| `500` | Sisäinen palvelinvirhe. |

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