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

# Atualizar encomenda de kit de teste em casa

> Alterar um kit de teste em casa enviado por correio

Atualiza a morada de entrega, o painel, os metadados ou os emails de resultados prontos de um pedido de kit de teste em casa. Inclui apenas os campos que queres alterar.

A morada de entrega e o painel só podem ser alterados enquanto o pedido estiver em `pending`, porque o kit físico é enviado no momento da expedição. `metadata` serve para o teu próprio registo e mantém-se editável durante todo o ciclo de vida do pedido.

Não existem endpoints para adicionar/remover painéis: um kit de teste em casa tem exatamente um painel (corresponde 1:1 a um produto de kit físico), pelo que a única operação de painel com sentido é a troca que fazes aqui.

Requer o âmbito `home_kit_orders_manage`.

## Pedido

### Parâmetros de caminho

**id** `string` *required*

Identificador único (UUID) do pedido de kit de teste em casa a atualizar.

### Parâmetros do corpo

Todos os parâmetros do corpo são opcionais — inclui apenas os campos que queres alterar.

**delivery\_address** `object`

A morada para a qual enviar o kit por correio — num de dois formatos: `{ location_id }` a referenciar uma localização de teste conhecida, ou os campos de morada em linha (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` opcionais — o mesmo vocabulário da API de localizações). Indica exatamente um — uma referência de localização ou uma morada em linha, não ambos.

**morada de entrega**

> [tab] Referenciar um local
>
> **location\_id** `string` *required*
>
> UUID de um local de análise conhecido para onde enviar o kit. Correlaciona com [Listar
> locais](https://docs.anivahealth.com/pt/api/locations/list-locations.md).

> [tab] Morada direta
>
> **name** `string` *required*
>
> Nome do destinatário, da empresa ou do local.
>
> **company\_name** `string`
>
> Empresa que guarda a encomenda para o destinatário — um intermediário `c/o` ou um departamento.
>
> **street** `string` *required*
>
> Nome da rua, sem o número da porta (por exemplo, `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Número da porta (por exemplo, `118` ou `12a`).
>
> **address\_line\_2** `string`
>
> Edifício, entrada ou andar.
>
> **city** `string` *required*
>
> **state** `string`
>
> Estado ou província. Opcional.
>
> **postal\_code** `string` *required*
>
> Código postal. Uma morada alemã (`country_code` `DE`) precisa de exatamente 5 dígitos, por exemplo, `10117`.
>
> **country\_code** `string` *required*
>
> Código ISO 3166-1 alpha-2 (duas letras, por exemplo, `DE`). Minúsculas são aceites e guardadas em
> maiúsculas.
>
> **phone** `string`
>
> Número de telefone do destinatário, com indicativo do país (por exemplo, `+4791234567`). A transportadora usa-o para
> avisar o destinatário sobre a encomenda, por exemplo, que está à espera num ponto de recolha. Omite-o
> e a transportadora não recebe nenhum número de telefone.
>
> **email** `string`
>
> E-mail do destinatário. A transportadora usa-o tal como `phone`. Omite-o e a transportadora não recebe nenhum
> e-mail.

> [!NOTE]
>
> **Packstation ou Postfiliale (apenas Alemanha):** define `street` como `Packstation` ou `Postfiliale`,
> `house_number` como o número de três dígitos da estação e `address_line_2` como o DHL
> Postnummer do destinatário (6–10 dígitos, espaços permitidos). Sem o Postnummer, não é possível registar o envio.
> Não é suportado Postfach.

**panel\_id** `string`

UUID do painel a associar em substituição do atual — com exatamente um painel por kit, uma troca
é a única operação com sentido. Apenas enquanto o pedido estiver em `pending`, e apenas para um painel que a Aniva
tenha configurado com um produto de kit de expedição (`422` caso contrário); trocar para o painel já associado
não tem efeito.

**metadata** `object`

Os teus próprios pares chave/valor. São **combinados** com os metadados existentes em vez de os substituírem: as chaves que
omitires são preservadas, uma chave enviada com valor `null` é eliminada e um objeto vazio `{}` limpa
tudo. Os limites correspondem aos de [Criar pedido de kit de teste em casa](https://docs.anivahealth.com/pt/api/home-kit-orders/create-home-kit.md) e
a validação é tudo-ou-nada — se qualquer chave for rejeitada, nada é gravado. Nunca coloques dados pessoais ou
clínicos em `metadata` — estes não são tratados como dados de paciente.

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

Substitui a lista de até 5 endereços que recebem um email assim que todos os resultados laboratoriais forem finais.
Envia `[]` para desativar os emails. Editável em todos os estados exceto `cancelled`. A tua chave precisa de
acesso `results_view` ao paciente, caso contrário devolve `403`. Consulta
[Emails de resultados prontos](https://docs.anivahealth.com/pt/concepts/results.md#e-mails-de-resultados-prontos).

## Resposta

Em caso de sucesso, a API devolve `200 OK` com o pedido de kit de teste em casa atualizado e o respetivo perfil incorporado.

**id** `string` *required*

Identificador único da encomenda de kit de teste em casa (UUID).

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

UUID do perfil a que pertence esta encomenda de kit de teste em casa.

**status** `string` *required*

Estado atual do pedido de kit de teste em casa. Um de `pending`, `dispatched`, `activated` ou `cancelled`.

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

A morada para onde enviar o kit — um de dois formatos: `{ location_id }`, que referencia um local de teste conhecido, ou os campos de morada inline (`name`, `street`, `city`, `postal_code`, `country_code`; `company_name` / `house_number` / `address_line_2` / `state` / `phone` / `email` opcionais — o mesmo vocabulário da API de localizações). Indica exatamente um — uma referência de localização ou uma morada inline, não ambos.

**morada de entrega**

> [tab] Referência de localização
>
> **location\_id** `string` *required*
>
> UUID do local de teste para onde o kit é enviado.

> [tab] Morada inline
>
> **name** `string` *required*
>
> Nome do destinatário, da empresa ou do local.
>
> **company\_name** `string`
>
> Empresa que guarda o volume para o destinatário — uma entidade `c/o` ou um departamento.
>
> **street** `string` *required*
>
> Nome da rua, sem o número da porta (p. ex., `Wilhelmstraße`).
>
> **house\_number** `string`
>
> Número da porta (p. ex., `118` ou `12a`).
>
> **address\_line\_2** `string`
>
> Edifício, entrada ou andar.
>
> **city** `string` *required*
>
> **state** `string`
>
> Estado ou província. Opcional.
>
> **postal\_code** `string` *required*
>
> **country\_code** `string` *required*
>
> Código ISO 3166-1 alpha-2 (duas letras, p. ex., `DE`).
>
> **phone** `string`
>
> **email** `string`

**lab\_code** `string`

Código de amostra de laboratório sob o qual os resultados são comunicados — impresso no kit físico e o que o
paciente lê na caixa como código de ativação. `null` até o kit ser embalado.
Só de leitura.

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

Data e hora da colheita comunicadas através de [Ativar](https://docs.anivahealth.com/pt/api/home-kit-orders/activate-home-kit.md) — quando o
paciente recolheu a amostra. `null` até o kit ser ativado.

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

A encomenda de kit de teste em casa que esta substitui, quando se trata de um kit de substituição. `null` numa encomenda normal. Consulta
[Criar encomenda de kit de teste em casa](https://docs.anivahealth.com/pt/api/home-kit-orders/create-home-kit.md).

**replacement\_reason** `string`

Motivo do envio da substituição. `null` numa encomenda normal.

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

Endereços que recebem um e-mail assim que todos os resultados laboratoriais forem definitivos, em minúsculas. Vazio quando desativado. Consulta
[E-mails de resultados prontos](https://docs.anivahealth.com/pt/concepts/results.md#e-mails-de-resultados-prontos).

**metadata** `object` *required*

Pares chave/valor definidos pelo parceiro, devolvidos sem alterações. Sempre presente — `{}` quando não definido.

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

Data e hora ISO 8601 de criação da encomenda de kit de teste em casa.

**updated\_at** `string`

Data e hora ISO 8601 da última atualização. Pode ser `null`.

**profile** `object` *required*

O perfil do paciente associado a esta encomenda de kit de teste em casa.

**perfil**

**id** `string`

Identificador único do perfil (UUID).

**handle** `string`

Handle ou nome de utilizador do perfil. Pode ser `null`.

**first\_name** `string`

Nome próprio. Pode ser `null`.

**last\_name** `string`

Apelido. Pode ser `null`.

**email** `string`

Endereço de e-mail. Pode ser `null`.

**phone** `string`

Número de telefone no formato E.164. Pode ser `null`.

**sex** `integer`

Sexo biológico segundo a norma ISO/IEC 5218. Pode ser `null`.

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

Data de nascimento no formato `YYYY-MM-DD`. Pode ser `null`.

**height** `number`

Altura em centímetros. Pode ser `null`.

**weight** `number`

Peso em quilogramas. Pode ser `null`.

**language** `string`

Idioma preferido: um dos 32 códigos em [Criar perfil](https://docs.anivahealth.com/pt/api/profiles/create-profile.md).

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

Se este perfil recebe e-mails transacionais (programáticos). Pode ser `null`.

**created\_at** `string`

Data e hora ISO 8601 da criação do perfil.

**updated\_at** `string`

Data e hora ISO 8601 da última atualização do perfil. Pode ser `null`.

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

O painel associado a este pedido de kit de teste em casa — sempre exatamente um (um kit de teste em casa corresponde 1:1 a um
produto de kit físico), substituído no local quando passas `panel_id`. Consulta os detalhes do painel (nome,
biomarcadores) através de [Listar painéis](https://docs.anivahealth.com/pt/api/panels/list-panels.md).

**Campos de associação do painel**

**panel\_id** `string`

UUID do painel — cruza com [Listar painéis](https://docs.anivahealth.com/pt/api/panels/list-panels.md).

**added\_at** `string`

Data e hora ISO 8601 em que o painel foi associado pela primeira vez a esta encomenda de kit de teste em casa.

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

Biomarcadores avulsos associados a esta encomenda de kit de teste em casa fora de qualquer painel. Cruza cada
`biomarker_id` com [Listar biomarcadores](https://docs.anivahealth.com/pt/api/biomarkers/list-biomarkers.md) com `home_kit=true` para obter os dados de apresentação.

**Campos de biomarcadores individuais**

**biomarker\_id** `integer`

Identificador do biomarcador — cruza com
[Listar biomarcadores](https://docs.anivahealth.com/pt/api/biomarkers/list-biomarkers.md) com `home_kit=true`.

**added\_at** `string`

Data e hora ISO 8601 em que o biomarcador foi associado pela primeira vez a esta encomenda de kit de teste em casa.

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

Pacotes associados a esta encomenda de kit de teste em casa, com a associação mais antiga primeiro — normalmente o kit para o paciente
e a amostra de volta para o laboratório. Vazio até a expedição imprimir uma etiqueta. Lê os
pacotes completos com [Listar envios](https://docs.anivahealth.com/pt/api/shipments/list-shipments.md) e `?home_kit_order_id=`.

**Campos de associação do envio**

**id** `string`

Referência do envio — cruza com [Obter envio](https://docs.anivahealth.com/pt/api/shipments/get-shipment.md).

**added\_at** `string`

Data e hora ISO 8601 em que o envio foi associado a esta encomenda de kit de teste em casa.

## Respostas de erro

| Estado | Descrição |
| - | - |
| `400` | Erro de validação — por ex., formato de UUID inválido ou um campo `delivery_address` em falta. |
| `403` | Proibido — a tua chave de API não tem acesso a esta operação, o pedido de kit de teste em casa está fora do teu âmbito de permissões ou definiste `results_ready_emails` sem acesso `results_view` ao paciente. |
| `404` | Pedido de kit de teste em casa não encontrado ou o painel de `panel_id` não existe. |
| `409` | Conflito — o pedido já não está em `pending`; a morada e o painel só podem ser alterados antes da expedição. |
| `409` | Conflito — o pedido é um kit de substituição, que mantém o painel do pedido que substitui. |
| `409` | Conflito — o pedido está em `cancelled` e enviaste `results_ready_emails`. |
| `422` | O painel não pode ser pedido como kit de teste em casa — não existe nenhum produto de kit de expedição configurado. |
| `500` | Erro interno do servidor. |

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