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

# Listaa kotitestipakkausten tilaukset

> Hae kotiin postitettavat kotitestipakkaukset, joihin API-avaimellasi on pääsy

Hae luettelo kotitestipakkaustilauksista. Kotitestipakkaustilauksessa lähetetään kotiin postitettava itsetestauspakkaus — Aniva lähettää pakkauksen, potilas ottaa näytteen itse kotona ja postittaa sen takaisin. Jokainen kotitestipakkaustilaus sisältää upotetun potilasprofiilin.

Kun `profile_id` annetaan, palauttaa kaikki kyseisen profiilin kotitestipakkaustilaukset. Kun se jätetään pois, palauttaa kaikki käytettävissä olevat kotitestipakkaustilaukset.

Vaatii `home_kit_orders_view`- tai `home_kit_orders_manage`-käyttöoikeuden.

## Pyyntö

### Kyselyparametrit

**profile\_id** `string`

Suodata profiilin UUID-tunnisteen mukaan. Kun tämä annetaan, palautetaan kaikki tämän profiilin kotitestipakkaustilaukset.

**lab\_code** `string`

Suodata laboratoriokoodin mukaan (tarkka vastaavuus) — yhdistä kädessä oleva fyysinen pakkaus tilaukseensa
siihen painetun koodin perusteella, esim. ennen päätepisteen [Aktivoi](https://docs.anivahealth.com/fi/api/home-kit-orders/activate-home-kit.md) kutsumista.

## Vastaus

Onnistuessaan API palauttaa vastauksen `200 OK` ja taulukon kotitestipakkaustilausobjekteja.

**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. Jokin arvoista `pending`, `dispatched`, `activated` tai `cancelled`.
Laboratoriotulosten valmistumisen tarkempi tila saadaan päätepisteestä [Hae tulokset](https://docs.anivahealth.com/fi/api/home-kit-orders/get-results.md).

**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 täsmälleen yksi (kotitestipakkaus vastaa
1:1 fyysistä pakkaustuotetta), ja sen voi vaihtaa päätepisteellä [Päivitä](https://docs.anivahealth.com/fi/api/home-kit-orders/update-home-kit.md),
kun tila on `pending`. 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.

## Toistuvat kutsut

Aniva tallentaa tämän päätepisteen vastauksen 5 minuutiksi kullekin API-avaimelle. Tämän ajan sisällä
tehty toistuva kutsu saa tallennetun vastauksen. Otsikot `Cache-Status` ja `Age` kertovat, että vastaus on
tallennettu ja kuinka vanha se on.

Jos haluat saada tiedon muutoksesta heti, tilaa webhook-tapahtuma `home_kit_order.created` sekä kunkin tilan tapahtuma, esimerkiksi `home_kit_order.activated`.
Katso [Toistuvat haut](https://docs.anivahealth.com/fi/concepts/webhooks.md#toistuvat-haut).

## Virhevastaukset

| Tila | Kuvaus |
| - | - |
| `400` | Validointivirhe — esimerkiksi `profile_id` ei ole kelvollinen UUID tai kyselyssä on tuntematon parametri. |
| `403` | Kielletty — API-avaimellasi ei ole oikeutta tähän toimintoon tai pyydetty profiili on käyttöoikeusalueesi ulkopuolella. |
| `500` | Sisäinen palvelinvirhe. |

```bash cURL (all home kit orders) theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/home-kit-orders \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (by profile) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/home-kit-orders?profile_id=a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d' \
  --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": "dispatched",
    "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-02T08: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": [
      {
        "biomarker_id": 42,
        "added_at": "2026-04-01T09:52:00Z"
      }
    ],
    "metadata": {},
    "replaces_home_kit_order_id": null,
    "replacement_reason": null,
    "results_ready_emails": [],
    "lab_code": "7642000123",
    "activated_at": null,
    "shipments": [
      { "id": "K2604021FQ7", "added_at": "2026-04-02T08:00:00Z" },
      { "id": "K260402P3XD", "added_at": "2026-04-02T08:00:00Z" }
    ]
  }
]
```

```json 403 theme={null}
{
  "error": "Access denied: profile is outside your permission scope"
}
```


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