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

# Pobierz zamówienie domowego zestawu testowego

> Pobierz wysyłkowy domowy zestaw testowy według ID

Pobierz pojedyncze zamówienie domowego zestawu testowego według jego UUID, wraz z osadzonym profilem pacjenta. Użyj tego endpointu, aby sprawdzić status zamówienia, przejrzeć adres dostawy lub zweryfikować dołączone panele i biomarkery.

Wymaga zakresu `home_kit_orders_view` lub `home_kit_orders_manage`.

## Żądanie

### Parametry ścieżki

**id** `string` *required*

Unikalny identyfikator (UUID) zamówienia domowego zestawu testowego do pobrania.

## Odpowiedź

W razie powodzenia API zwraca `200 OK` z zamówieniem domowego zestawu testowego i osadzonym w nim profilem.

**id** `string` *required*

Unikalny identyfikator zamówienia domowego zestawu testowego (UUID).

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

UUID profilu, do którego należy to zamówienie domowego zestawu testowego.

**status** `string` *required*

Bieżący status zamówienia domowego zestawu testowego. Jedna z wartości: `pending`, `dispatched`, `activated` lub `cancelled`.
Szczegółowy stan realizacji wyników laboratoryjnych pochodzi z [Pobierz wyniki](https://docs.anivahealth.com/pl/api/home-kit-orders/get-results.md).

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

Adres, na który ma zostać wysłany zestaw — w jednej z dwóch postaci: albo `{ location_id }` wskazujące znaną lokalizację badań, albo pola adresu wpisane bezpośrednio (`name`, `street`, `city`, `postal_code`, `country_code`; pola `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` są opcjonalne — takie samo nazewnictwo jak w API lokalizacji). Podaj dokładnie jedną opcję — odniesienie do lokalizacji albo adres wpisany bezpośrednio, nie obie naraz.

**adres dostawy**

> [tab] Odniesienie do lokalizacji
>
> **location\_id** `string` *required*
>
> UUID lokalizacji badań, do której wysyłany jest zestaw.

> [tab] Adres wpisany bezpośrednio
>
> **name** `string` *required*
>
> Nazwa odbiorcy, firmy lub lokalizacji.
>
> **company\_name** `string`
>
> Firma przechowująca przesyłkę dla odbiorcy — podmiot typu `c/o` lub dział.
>
> **street** `string` *required*
>
> Nazwa ulicy bez numeru domu (np. `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Numer domu (np. `118` lub `12a`).
>
> **address\_line\_2** `string`
>
> Budynek, wejście lub piętro.
>
> **city** `string` *required*
>
> **state** `string`
>
> Stan lub województwo. Pole opcjonalne.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> Kod ISO 3166-1 alpha-2 (dwie litery, np. `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Kod próbki w laboratorium, pod którym raportowane są wyniki — wydrukowany na fizycznym zestawie i odczytywany
przez pacjenta z pudełka jako kod aktywacyjny. `null` do czasu spakowania zestawu.
Tylko do odczytu.

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

Znacznik czasu pobrania zgłoszony przez [Aktywuj](https://docs.anivahealth.com/pl/api/home-kit-orders/activate-home-kit.md) — moment,
w którym pacjent pobrał próbkę. `null` do czasu aktywacji zestawu.

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

Zamówienie domowego zestawu testowego, które to zamówienie zastępuje, gdy jest to zestaw zastępczy. `null` w przypadku zwykłego zamówienia. Zobacz
[Utwórz zamówienie domowego zestawu testowego](https://docs.anivahealth.com/pl/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Powód wysłania zestawu zastępczego. `null` w przypadku zwykłego zamówienia.

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

Adresy zapisane małymi literami, z których każdy otrzymuje jednego e-maila, gdy wszystkie wyniki
laboratoryjne będą ostateczne. Puste, gdy wyłączone. Zobacz
[E-maile o gotowych wynikach](https://docs.anivahealth.com/pl/concepts/results.md#e-maile-o-gotowosci-wynikow).

**metadata** `object` *required*

Pary klucz/wartość zdefiniowane przez partnera, zwracane w niezmienionej postaci. Pole jest zawsze obecne — `{}`, gdy nie ustawiono żadnych wartości.

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

Znacznik czasu ISO 8601 utworzenia zamówienia domowego zestawu testowego.

**updated\_at** `string`

Znacznik czasu ISO 8601 ostatniej aktualizacji. Może mieć wartość `null`.

**profile** `object` *required*

Profil pacjenta powiązany z tym zamówieniem domowego zestawu testowego.

**profil**

**id** `string`

Unikalny identyfikator profilu (UUID).

**handle** `string`

Identyfikator lub nazwa użytkownika profilu. Może mieć wartość `null`.

**first\_name** `string`

Imię. Może mieć wartość `null`.

**last\_name** `string`

Nazwisko. Może mieć wartość `null`.

**email** `string`

Adres e-mail. Może mieć wartość `null`.

**phone** `string`

Numer telefonu w formacie E.164. Może mieć wartość `null`.

**sex** `integer`

Płeć biologiczna wg ISO/IEC 5218. Może mieć wartość `null`.

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

Data urodzenia w formacie `YYYY-MM-DD`. Może mieć wartość `null`.

**height** `number`

Wzrost w centymetrach. Może mieć wartość `null`.

**weight** `number`

Waga w kilogramach. Może mieć wartość `null`.

**language** `string`

Preferowany język: jeden z 32 kodów w [Utwórz profil](https://docs.anivahealth.com/pl/api/profiles/create-profile.md).

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

Czy ten profil otrzymuje e-maile transakcyjne (wysyłane automatycznie). Może mieć wartość `null`.

**created\_at** `string`

Znacznik czasu ISO 8601 utworzenia profilu.

**updated\_at** `string`

Znacznik czasu ISO 8601 ostatniej aktualizacji profilu. Może mieć wartość `null`.

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

Panel przypisany do tego zamówienia domowego zestawu testowego — zawsze dokładnie jeden (domowy zestaw testowy odpowiada 1:1
fizycznemu produktowi zestawu), możliwy do zmiany przez [Zaktualizuj](https://docs.anivahealth.com/pl/api/home-kit-orders/update-home-kit.md), dopóki ma status
`pending`. Szczegóły panelu (nazwa, biomarkery) sprawdzisz w [Wyświetl panele](https://docs.anivahealth.com/pl/api/panels/list-panels.md).

**Pola dołączonego panelu**

**panel\_id** `string`

UUID panelu — sprawdź w [Wyświetl panele](https://docs.anivahealth.com/pl/api/panels/list-panels.md).

**added\_at** `string`

Znacznik czasu ISO 8601 pierwszego dołączenia panelu do tego zamówienia domowego zestawu testowego.

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

Pojedyncze biomarkery przypisane do tego zamówienia domowego zestawu testowego poza panelem. Dopasuj każde
`biomarker_id` do danych z [Wyświetl biomarkery](https://docs.anivahealth.com/pl/api/biomarkers/list-biomarkers.md) z parametrem `home_kit=true`, aby uzyskać dane do wyświetlenia.

**Pola pojedynczego biomarkera**

**biomarker\_id** `integer`

Identyfikator biomarkera — sprawdź w
[Wyświetl biomarkery](https://docs.anivahealth.com/pl/api/biomarkers/list-biomarkers.md) z `home_kit=true`.

**added\_at** `string`

Znacznik czasu ISO 8601 pierwszego dołączenia biomarkera do tego zamówienia domowego zestawu testowego.

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

Przesyłki powiązane z tym zamówieniem domowego zestawu testowego, od najstarszego powiązania — zazwyczaj zestaw do pacjenta
i próbka z powrotem do laboratorium. Lista jest pusta, dopóki dział realizacji nie wydrukuje etykiety. Pełne dane
przesyłek odczytasz przez [Wyświetl przesyłki](https://docs.anivahealth.com/pl/api/shipments/list-shipments.md) z `?home_kit_order_id=`.

**Pola powiązania przesyłki**

**id** `string`

Identyfikator przesyłki — sprawdź w [Pobierz przesyłkę](https://docs.anivahealth.com/pl/api/shipments/get-shipment.md).

**added\_at** `string`

Znacznik czasu ISO 8601 powiązania przesyłki z tym zamówieniem domowego zestawu testowego.

## Powtarzane wywołania

Aniva przechowuje odpowiedź tego endpointu przez 60 minut dla każdego klucza API. Ponowne wywołanie w
tym czasie zwraca zapisaną odpowiedź, dopóki zamówienie domowego zestawu testowego się nie zmieni. Po zmianie otrzymasz świeżą
odpowiedź. Nagłówki `Cache-Status` i `Age` pokazują, że odpowiedź jest
zapisana i jaki jest jej wiek.

Aby dowiedzieć się o zmianie od razu, zasubskrybuj zdarzenia webhooka `home_kit_order.created` oraz zdarzenie dla każdego statusu, na przykład `home_kit_order.activated`.
Zobacz [Powtarzane odczyty](https://docs.anivahealth.com/pl/concepts/webhooks.md#powtarzane-odczyty).

## Odpowiedzi z błędami

| Status | Opis |
| - | - |
| `400` | Nieprawidłowy format ID — podana wartość nie jest prawidłowym UUID. |
| `403` | Brak dostępu — twój klucz API nie ma dostępu do tej operacji lub zamówienie domowego zestawu testowego jest poza twoim zakresem uprawnień. |
| `404` | Nie znaleziono zamówienia domowego zestawu testowego. |
| `500` | Wewnętrzny błąd serwera. |

```bash cURL theme={null}
curl --request GET \
  --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": "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 400 theme={null}
{
  "error": "id: Invalid home kit ID format"
}
```

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