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

# Iegūt mājas testa komplektu pasūtījumu sarakstu

> Iegūt tavai API atslēgai pieejamos paštesta komplektus ar piegādi uz mājām

Iegūsti mājas testa komplektu pasūtījumu sarakstu. Mājas testa komplekta pasūtījums nosūta mājās veicamu testa komplektu pa pastu — Aniva nosūta komplektu, pacients mājās pats paņem paraugu un nosūta to atpakaļ pa pastu. Katrā mājas testa komplekta pasūtījumā ir iekļauts pacienta profils.

Ja norādīts `profile_id`, atgriež visus šī profila mājas testa komplektu pasūtījumus. Ja tas nav norādīts, atgriež visus pieejamos mājas testa komplektu pasūtījumus.

Nepieciešams `home_kit_orders_view` vai `home_kit_orders_manage` tvērums.

## Pieprasījums

### Vaicājuma parametri

**profile\_id** `string`

Filtrē pēc profila UUID. Ja norādīts, tiek atgriezti visi šī profila mājas testa komplektu pasūtījumi.

**lab\_code** `string`

Filtrē pēc laboratorijas koda (precīza atbilstība) — atrodi rokās esošajam fiziskajam komplektam atbilstošo pasūtījumu pēc uz tā
uzdrukātā koda, piem., pirms izsauc [Aktivizēt](https://docs.anivahealth.com/lv/api/home-kit-orders/activate-home-kit.md).

## Atbilde

Veiksmīgas izpildes gadījumā API atgriež `200 OK` ar mājas testa komplekta pasūtījumu objektu masīvu.

**id** `string` *required*

Unikālais mājas testa komplekta pasūtījuma identifikators (UUID).

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

Tā profila UUID, kuram pieder šis mājas testa komplekta pasūtījums.

**status** `string` *required*

Pašreizējais mājas testa komplekta pasūtījuma statuss. Viena no vērtībām: `pending`, `dispatched`, `activated` vai `cancelled`.
Detalizēta informācija par laboratorijas rezultātu gatavību tiek iegūta no [Iegūt rezultātus](https://docs.anivahealth.com/lv/api/home-kit-orders/get-results.md).

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

Adrese, uz kuru nosūtīt komplektu — vienā no divām formām: vai nu `{ location_id }`, kas atsaucas uz zināmu testēšanas vietu, vai tiešās adreses lauki (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` nav obligāti — tie paši lauki kā atrašanās vietu API). Norādi tieši vienu — atsauci uz vietu vai tiešo adresi, ne abas.

**piegādes adrese**

> [tab] Atsauce uz vietu
>
> **location\_id** `string` *required*
>
> Tās testēšanas vietas UUID, uz kuru tiek nosūtīts komplekts.

> [tab] Tiešā adrese
>
> **name** `string` *required*
>
> Saņēmēja, uzņēmuma vai vietas nosaukums.
>
> **company\_name** `string`
>
> Uzņēmums, kas pieņem sūtījumu saņēmēja vietā — `c/o` puse vai nodaļa.
>
> **street** `string` *required*
>
> Ielas nosaukums bez mājas numura (piem., `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Mājas numurs (piem., `118` vai `12a`).
>
> **address\_line\_2** `string`
>
> Ēka, ieeja vai stāvs.
>
> **city** `string` *required*
>
> **state** `string`
>
> Štats vai province. Nav obligāts.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> ISO 3166-1 alpha-2 kods (divi burti, piem., `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Laboratorijas parauga kods, zem kura tiek ziņoti rezultāti — uzdrukāts uz fiziskā komplekta, un tas ir kods, ko
pacients nolasa no kastītes kā aktivizācijas kodu. `null`, līdz komplekts ir iepakots.
Tikai lasīšanai.

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

Parauga paņemšanas laikspiedols, kas ziņots ar [Aktivizēt](https://docs.anivahealth.com/lv/api/home-kit-orders/activate-home-kit.md) — kad
pacients paņēma paraugu. `null`, līdz komplekts ir aktivizēts.

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

Mājas testa komplekta pasūtījums, ko šis aizstāj, ja tas ir aizstāšanas komplekts. `null` parastam pasūtījumam. Skati
[Izveidot mājas testa komplekta pasūtījumu](https://docs.anivahealth.com/lv/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Kāpēc tika nosūtīts aizstāšanas komplekts. `null` parastam pasūtījumam.

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

Adreses mazajiem burtiem, no kurām katra saņem vienu e-pastu, tiklīdz visi laboratorijas rezultāti ir galīgi. Tukšs, kad izslēgts. Skatīt
[E-pasti par gataviem rezultātiem](https://docs.anivahealth.com/lv/concepts/results.md#e-pasti-par-gataviem-rezultatiem).

**metadata** `object` *required*

Partnera definēti atslēgu un vērtību pāri, kas tiek atgriezti nemainītā veidā. Vienmēr norādīts — `{}`, ja nav iestatīts.

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

ISO 8601 laikspiedols, kad tika izveidots mājas testa komplekta pasūtījums.

**updated\_at** `string`

Pēdējā atjauninājuma ISO 8601 laikspiedols. Var būt `null`.

**profile** `object` *required*

Pacienta profils, kas saistīts ar šo mājas testa komplekta pasūtījumu.

**profils**

**id** `string`

Unikāls profila identifikators (UUID).

**handle** `string`

Profila segvārds vai lietotājvārds. Var būt `null`.

**first\_name** `string`

Vārds. Var būt `null`.

**last\_name** `string`

Uzvārds. Var būt `null`.

**email** `string`

E-pasta adrese. Var būt `null`.

**phone** `string`

Tālruņa numurs E.164 formātā. Var būt `null`.

**sex** `integer`

Bioloģiskais dzimums saskaņā ar ISO/IEC 5218. Var būt `null`.

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

Dzimšanas datums formātā `YYYY-MM-DD`. Var būt `null`.

**height** `number`

Augums centimetros. Var būt `null`.

**weight** `number`

Svars kilogramos. Var būt `null`.

**language** `string`

Vēlamā valoda: viens no 32 kodiem sadaļā [Izveidot profilu](https://docs.anivahealth.com/lv/api/profiles/create-profile.md).

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

Vai šis profils saņem darījumu (programmatiskos) e-pastus. Var būt `null`.

**created\_at** `string`

ISO 8601 laikspiedols, kad profils tika izveidots.

**updated\_at** `string`

Pēdējā profila atjauninājuma ISO 8601 laikspiedols. Var būt `null`.

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

Šim mājas testa komplekta pasūtījumam pievienotais panelis — vienmēr tieši viens (mājas testa komplekts 1:1 atbilst
fiziskam komplekta produktam), un to var nomainīt ar [Atjaunināt](https://docs.anivahealth.com/lv/api/home-kit-orders/update-home-kit.md), kamēr tas ir
`pending`. Paneļa informāciju (nosaukumu, biomarķierus) meklē sadaļā [Paneļu saraksts](https://docs.anivahealth.com/lv/api/panels/list-panels.md).

**Paneļa pievienošanas lauki**

**panel\_id** `string`

Paneļa UUID — salīdzini ar [Uzskaitīt paneļus](https://docs.anivahealth.com/lv/api/panels/list-panels.md).

**added\_at** `string`

ISO 8601 laikspiedols, kad panelis pirmo reizi tika pievienots šim mājas testa komplekta pasūtījumam.

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

Atsevišķi izvēlēti biomarķieri, kas pievienoti šim mājas testa komplekta pasūtījumam ārpus jebkura paneļa. Salīdzini katru
`biomarker_id` ar [Biomarķieru saraksts](https://docs.anivahealth.com/lv/api/biomarkers/list-biomarkers.md) un `home_kit=true`, lai iegūtu attēlošanas datus.

**Atsevišķa biomarķiera lauki**

**biomarker\_id** `integer`

Biomarķiera identifikators — salīdzini ar
[Uzskaitīt biomarķierus](https://docs.anivahealth.com/lv/api/biomarkers/list-biomarkers.md) ar `home_kit=true`.

**added\_at** `string`

ISO 8601 laikspiedols, kad biomarķieris pirmo reizi tika pievienots šim mājas testa komplekta pasūtījumam.

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

Pakas, kas saistītas ar šo mājas testa komplekta pasūtījumu, sākot ar vecāko saiti — parasti komplekts pacientam
un paraugs atpakaļ uz laboratoriju. Tukšs, līdz izpildes dienests izdrukā uzlīmi. Pilnu
paku informāciju lasi ar [Sūtījumu saraksts](https://docs.anivahealth.com/lv/api/shipments/list-shipments.md) un `?home_kit_order_id=`.

**Sūtījuma saites lauki**

**id** `string`

Sūtījuma atsauce — salīdzini ar [Iegūt sūtījumu](https://docs.anivahealth.com/lv/api/shipments/get-shipment.md).

**added\_at** `string`

ISO 8601 laikspiedols, kad sūtījums tika piesaistīts šim mājas testa komplekta pasūtījumam.

## Atkārtoti izsaukumi

Aniva saglabā šī galapunkta atbildi 5 minūtes katrai API atslēgai. Atkārtots izsaukums šajā
laikā saņem saglabāto atbildi. Galvenes `Cache-Status` un `Age` rāda, ka atbilde ir
saglabāta un cik veca tā ir.

Lai par izmaiņām uzzinātu uzreiz, abonē tīmekļa āķa notikumus `home_kit_order.created` un katra statusa notikumu, piemēram, `home_kit_order.activated`.
Skati [Atkārtota lasīšana](https://docs.anivahealth.com/lv/concepts/webhooks.md#atkartota-nolasisana).

## Kļūdu atbildes

| Statuss | Apraksts |
| - | - |
| `400` | Validācijas kļūda — piemēram, `profile_id` nav derīgs UUID vai vaicājumā ir nezināms parametrs. |
| `403` | Aizliegts — tavai API atslēgai nav piekļuves šai darbībai, vai pieprasītais profils ir ārpus tava atļauju tvēruma. |
| `500` | Iekšēja servera kļūda. |

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