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

# Anuluj zamówienie domowego zestawu testowego

> Anuluj wysyłkowy domowy zestaw testowy

Anuluj zamówienie domowego zestawu testowego, ustawiając jego status na `cancelled`. Anulowane zamówienie domowego zestawu testowego jest zwracane w odpowiedzi.

Anulować można tylko zamówienie ze statusem `pending`. Gdy ma status `dispatched`, zestaw został już spakowany i zaetykietowany przez centrum realizacji, więc anulowanie zwraca `409` — tak samo jak w przypadku zamówienia ze statusem `activated`.

Jeśli zestaw został już zamówiony w centrum realizacji, najpierw anulujemy go tam, zanim anulujemy twoje zamówienie, a wywołanie kończy się błędem, gdy centrum nie zgadza się na wycofanie: `409`, gdy zestaw jest już spakowany i zaetykietowany, oraz `502`, gdy centrum realizacji odrzuciło anulowanie lub nie można było się z nim połączyć. W każdym przypadku błędu **nic się nie zmienia** — zamówienie nadal obowiązuje, a żądanie zakończone kodem `502` można bezpiecznie ponowić.

Anulowanie zamówienia, które ma już status `cancelled`, zwraca `200` z tym zamówieniem, niezależnie od tego, z jakiego statusu zostało anulowane. Odpowiedź zawiera `Idempotent-Replayed: true`, dzięki czemu odróżnisz powtórzone wywołanie od tego, które wykonało operację. Zobacz [Idempotentność](https://docs.anivahealth.com/pl/concepts/idempotency.md).

Wymaga zakresu `home_kit_orders_manage`.

## Żądanie

### Parametry ścieżki

**id** `string` *required*

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

## Odpowiedź

W razie powodzenia API zwraca `200 OK` z anulowanym zamówieniem domowego zestawu testowego i osadzonym w nim profilem. Zamówienie, które zostało już anulowane, zwraca to samo `200`.

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

Status zamówienia domowego zestawu testowego. Po pomyślnym anulowaniu będzie miał wartość `cancelled`.

**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 dołączony do tego zamówienia domowego zestawu testowego przed anulowaniem — zawsze dokładnie jeden
(domowy zestaw testowy odpowiada 1:1 fizycznemu produktowi zestawu). Szczegóły panelu (nazwę, biomarkery) sprawdzisz przez
[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 dołączone do tego zamówienia domowego zestawu testowego przed anulowaniem. Sprawdź
każdy `biomarker_id` w [Wyświetl biomarkery](https://docs.anivahealth.com/pl/api/biomarkers/list-biomarkers.md) z `home_kit=true`, aby pobrać 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*

Paczki powiązane z tym zamówieniem domowego zestawu testowego przed anulowaniem, od najstarszego powiązania. Pełne
informacje o paczkach pobierzesz 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.

## Odpowiedzi z błędami

| Status | Opis |
| - | - |
| `400` | Nieprawidłowy format ID — podana wartość nie jest poprawnym UUID. |
| `403` | Brak dostępu — twój klucz API nie ma dostępu do tej operacji lub zamówienie domowego zestawu testowego wykracza poza zakres twoich uprawnień. |
| `404` | Nie znaleziono zamówienia domowego zestawu testowego. |
| `409` | Konflikt — zamówienie nie ma już statusu `pending` (zostało wysłane lub aktywowane) albo jego zestaw został już spakowany i zaetykietowany przez centrum realizacji. |
| `500` | Wewnętrzny błąd serwera. |
| `502` | Centrum realizacji odrzuciło anulowanie (w odpowiedzi znajduje się powód) lub nie można było się z nim połączyć. Nic się nie zmieniło; zamówienie nadal obowiązuje. |

```bash cURL theme={null}
curl --request DELETE \
  --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": "cancelled",
  "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-03T10: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": [],
  "metadata": {},
  "replaces_home_kit_order_id": null,
  "replacement_reason": null,
  "results_ready_emails": [],
  "lab_code": null,
  "activated_at": null,
  "shipments": []
}
```

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

```json 409 theme={null}
{
  "error": "A home kit order can only be cancelled while it is pending. Once it is dispatched or activated the physical kit has been packed and labelled and can no longer be called back."
}
```

```json 502 theme={null}
{
  "error": "Fulfilment refused the cancellation (Order is already in fulfillment). The home kit order was NOT cancelled."
}
```


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