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

# Päivitä lähetys

> Muokkaa lähetyksen tietoja ennen noutoa

Päivitä lähetyksen tietoja, kuten noutoaikataulua, pakettien määrää tai lisätietoja. Jos jokin logistiikan kannalta olennainen kenttä muuttuu (noutopäivä, kellonaika, pakettien määrä tai paino), nykyinen logistiikkatilaus peruutetaan ja uusi luodaan automaattisesti. Kentät, jotka jätät pois, säilyvät nykyisestä lähetyksestä. Päivitetyt aikataulukentät tarkistetaan [noutoaikataulun sääntöjen](https://docs.anivahealth.com/fi/concepts/shipments.md#noutoaikataulun-saeaennoet) mukaisesti.

> [!WARNING]
>
> Lähetyksiä ei voi muokata noudon jälkeen. Jo noudetun lähetyksen päivitysyritys palauttaa
> tilakoodin `409 Conflict`.

Kotitestipakkauksen lähetyksellä on jo tulostettu osoitekortti, joten vain `notes`-kenttää voi muuttaa. Uusi noutoaikaikkuna
tai paino kotitestipakkauksen lähetykselle palauttaa tilakoodin `409 Conflict`; peruuta se ja luo sen sijaan uusi lähetys.

Kotitestipakkauksen lähetyksen päivittäminen edellyttää, että jokainen siihen linkitetty kotitestipakkauksen tilaus kuuluu pääsykontekstiisi.
Muuten kutsu palauttaa tilakoodin `403`. Katso [Pääsyoikeudet](https://docs.anivahealth.com/fi/concepts/shipments.md#kaeyttoeoikeudet).

## Pyyntö

### Polkuparametrit

**id** `string` *required*

Lähetyksen viitetunnus (esim. `P2611194821`).

### Runkoparametrit

Kaikki runkoparametrit ovat valinnaisia — sisällytä vain kentät, joita haluat muuttaa.

**pickup\_date** `string`

Uusi noutopäivä muodossa `YYYY-MM-DD` lähtöpaikan aikavyöhykkeen mukaan.

**pickup\_time\_from** `string`

Uusi aikaisin noutoaika muodossa `HH:MM`, joka tulkitaan paikalliseksi kellonajaksi lähtöpaikan
aikavyöhykkeellä.

**pickup\_time\_till** `string`

Uusi myöhäisin noutoaika muodossa `HH:MM`, joka tulkitaan paikalliseksi kellonajaksi lähtöpaikan
aikavyöhykkeellä.

**package\_count** `integer`

Uusi pakettien määrä.

**weight** `number`

Uusi paino (kg).

**notes** `string`

Uudet lisätiedot tai huomautukset. Enintään 128 merkkiä.

## Vastaus

Onnistuessaan API palauttaa tilakoodin `200 OK` ja päivitetyn lähetyksen.

**id** `string` *required*

Lähetyksen viitetunniste.

**status** `string` *required*

Lähetyksen elinkaaritila. Yksi arvoista `pending`, `in_transit`, `delivered`, `fault` tai `cancelled`.

**logistics\_provider** `string` *required*

Logistiikkapalveluntarjoaja. Yksi arvoista `go`, `dhl_parcel`, `dhl_warenpost`, `rotrunner`, `rapido`,
`ups` tai `dhl_express`. Kotitestipaketin lähetys on `dhl_parcel`, tai `dhl_warenpost`, kun se lähetetään ulkomaille
Warenpost International -lähetyksenä.

**tracking\_number** `string`

Logistiikkapalveluntarjoajan ulkoinen seurantanumero. Voi olla `null`.

**contents** `string`

Vapaamuotoinen kuvaus paketin sisällöstä sellaisena kuin se annettiin luotaessa. Voi olla `null`.

**booked\_by** `string` *required*

Kuka tulosti lähetystarran: `aniva` tai `external`. Vain `aniva`-lähetykset hyväksyvät tämän kutsun.

**paired\_with** `string`

Kahden paketin lähetyksen toisen paketin viite. `null` yhdensuuntaiselle paketille.

**origin** `object`

Nouto-osoite. Voi olla `null`.

**osoiteobjekti**

**name** `string` *required*

Vastaanottajan, yrityksen tai toimipisteen nimi.

**company\_name** `string`

Yritys / c/o-rivi. Voi olla `null`.

**street** `string` *required*

Kadunnimi ilman talon numeroa.

**house\_number** `string`

Talon numero. Voi olla `null`.

**address\_line\_2** `string`

Rakennus, porras tai kerros. Voi olla `null`.

**city** `string` *required*

Kaupunki.

**state** `string`

Osavaltio tai maakunta. Voi olla `null`.

**postal\_code** `string` *required*

Postinumero.

**country\_code** `string` *required*

ISO 3166-1 alpha-2 -maakoodi.

**phone** `string`

Yhteyspuhelinnumero. Voi olla `null`.

**email** `string`

Yhteyssähköposti. Voi olla `null`.

**destination** `object`

Toimitusosoite. Sama rakenne kuin kentässä `origin`. Voi olla `null`.

**pickup** `object`

Ajoitettu noutoaikaikkuna. Voi olla `null`.

**pickup-objekti**

**from** `string` *required*

Noutoaikaikkunan alku UTC-ajankohtana (ISO 8601 ja `Z`-pääte).

**till** `string` *required*

Noutoaikaikkunan loppu UTC-ajankohtana (ISO 8601 ja `Z`-pääte).

**timezone** `string` *required*

Noutopaikan IANA-aikavyöhyke (esim. `Europe/Berlin`). Käytä tätä kenttien `from` / `till` esittämiseen noutopaikan paikallisessa ajassa.

**notes** `string`

Valinnaiset muistiinpanot. Voi olla `null`.

**status\_updates** `object[]` *required*

Logistiikkapalveluntarjoajan elinkaaritapahtumat aikajärjestyksessä (vanhin ensin). Jokaisessa merkinnässä on
`state`, `code`, `detail_code`, `status`, `description`, `location` ja `time`. Katso kenttien kuvaukset kohdasta [Hae
lähetys](https://docs.anivahealth.com/fi/api/shipments/get-shipment.md). Tyhjä taulukko, jos tapahtumia ei ole vielä havaittu.

**appointments** `ShipmentAppointmentLink[]` *required*

Tähän lähetykseen linkitetyt ajanvaraukset, vanhin linkitys ensin. Jokainen merkintä on `{ id, added_at }`;
hae tiedot kullekin `id`-arvolle kutsulla [Hae ajanvaraus](https://docs.anivahealth.com/fi/api/appointments/get-appointment.md).
Vain pääsykontekstiisi kuuluvat ajanvaraukset listataan.

**home\_kit\_orders** `ShipmentHomeKitOrderLink[]` *required*

Tähän lähetykseen liitetyt kotitestitilaukset, vanhin liitos ensin, samassa `{ id, added_at }` -muodossa.
Vain käyttöoikeusalueeseesi kuuluvat tilaukset listataan. Tyhjä taulukko vastaanottojen paketeille.

**synced\_at** `string`

Milloin lähetys täsmäytettiin viimeksi kuljetusyhtiön kanssa (UTC-ajankohta). `null` ensimmäiseen
synkronointiin asti.

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

Luontiaikaleima (ISO 8601).

**updated\_at** `string`

Viimeisimmän päivityksen aikaleima (ISO 8601). Voi olla `null`.

## Virhevastaukset

| Tila | Kuvaus |
| - | - |
| `400` | Validointivirhe – esim. virheellinen päivämäärä- tai aikamuoto. |
| `403` | Estetty – API-avaimellasi ei ole käyttöoikeutta tähän toimintoon, lähetys on käyttöoikeuskontekstisi ulkopuolella tai linkitetty kotitestitilaus on käyttöoikeuskontekstisi ulkopuolella. |
| `404` | Lähetystä ei löytynyt. |
| `409` | Lähetystä ei voi muokata noudon jälkeen, tai kyseessä on kotitestipaketti, jonka osoitekortti on tulostettu ja pyyntö muuttaa muutakin kuin kenttää `notes`. |
| `501` | Lähetys on `external` – sitä ei ole varattu Anivan kautta eikä sitä voi muuttaa täällä. |
| `500` | Sisäinen palvelinvirhe. |
| `502` | Logistiikkapalvelun tarjoaja hylkäsi pyynnön (esim. peruutus tai uudelleenluonti epäonnistui). Sisältää palveluntarjoajan virheilmoituksen. |

```bash cURL theme={null}
curl --request PATCH \
  --url https://anivahealth.com/api/v1/shipments/P2611194821 \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "pickup_date": "2026-04-16",
    "pickup_time_from": "10:00",
    "pickup_time_till": "13:00"
  }'
```

```json 200 theme={null}
{
  "id": "P2611194821",
  "status": "pending",
  "logistics_provider": "go",
  "tracking_number": null,
  "contents": "Medizinisch freigestellte Probe",
  "booked_by": "aniva",
  "paired_with": null,
  "origin": {
    "name": "Aniva Berlin Mitte",
    "company_name": null,
    "street": "Unter den Linden",
    "house_number": "42",
    "address_line_2": null,
    "postal_code": "10117",
    "city": "Berlin",
    "state": null,
    "country_code": "DE",
    "phone": "+4930987654321",
    "email": "berlin-mitte@anivahealth.com"
  },
  "destination": {
    "name": "LabClinic GmbH",
    "company_name": null,
    "street": "Laborstraße",
    "house_number": "10",
    "address_line_2": null,
    "postal_code": "80331",
    "city": "München",
    "state": null,
    "country_code": "DE",
    "phone": null,
    "email": null
  },
  "pickup": {
    "from": "2026-04-16T08:00:00Z",
    "till": "2026-04-16T11:00:00Z",
    "timezone": "Europe/Berlin"
  },
  "notes": null,
  "status_updates": [],
  "appointments": [],
  "home_kit_orders": [],
  "synced_at": "2026-04-03T15:00:00Z",
  "created_at": "2026-04-03T14:30:00Z",
  "updated_at": "2026-04-03T15:10:00Z"
}
```

```json 409 theme={null}
{
  "error": "Shipment cannot be modified after pickup"
}
```

```json 502 theme={null}
{
  "error": "Logistics provider error: The cancellation notice period has already been exceeded. Cancellation is no longer possible via the web service. Please contact the GO! station.",
  "logistics_error_code": 4006
}
```


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