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

# List opp forsendelser

> Hent forsendelser, filtrert etter time, hjemmesettbestilling eller status

Hent forsendelsene som er tilgjengelige for API-nøkkelen din, nyeste først. Alle pakker ligger i denne ene listen:
budhenting fra en praksis, settet på vei til en pasient med hjemmetestsett, og prøven på
vei tilbake. Filtrer på ett overordnet objekt med `appointment_id` eller `home_kit_order_id`.

Krever tilgangsomfanget `shipments_view` eller `shipments_manage`.

Svaret kommer fra databasen vår og kaller aldri transportøren. En bakgrunnssynkronisering oppdaterer hver
forsendelse (hvert 10. minutt for GO!, hver time for DHL), og `synced_at` på hver rad viser når
transportøren sist ble spurt.

## Forespørsel

### Spørreparametere

**appointment\_id** `string`

Bare forsendelser knyttet til denne timen (UUID). `404` når timen ikke finnes, `403`
når den er utenfor din tilgangskontekst.

**home\_kit\_order\_id** `string`

Bare forsendelser knyttet til denne bestillingen av hjemmetestsett (UUID). Normalt returneres to rader – settet på
vei til pasienten og prøven tilbake til laboratoriet (`destination` er laboratoriet). Samme
`404`- / `403`-regler som for `appointment_id`.

**status** `string`

Bare forsendelser med denne statusen. En av `pending`, `in_transit`, `delivered`, `fault`, `cancelled`.

**limit** `integer`

Maksimalt antall forsendelser som returneres. Standard er 100, maks 500.

**offset** `integer`

Antall forsendelser som hoppes over. Standard er 0. Sorteringen er stabil (`created_at` synkende, deretter
referanse), slik at sider ikke overlapper.

## Respons

Ved suksess returnerer API-et `200 OK` med en liste over forsendelsesobjekter.

**id** `string` *required*

Referanseidentifikator for forsendelsen.

**status** `string` *required*

Livssyklusstatus for forsendelsen. En av `pending`, `in_transit`, `delivered`, `fault` eller
`cancelled`.

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

Logistikkleverandør. Én av `go`, `dhl_parcel`, `dhl_warenpost`, `rotrunner`, `rapido`,
`ups` eller `dhl_express`. En hjemmesettpakke er `dhl_parcel`, eller `dhl_warenpost` når den sendes utenlands
som Warenpost International.

**tracking\_number** `string`

Eksternt sporingsnummer fra logistikkleverandøren. Kan være `null`.

**contents** `string`

Fritekstbeskrivelse av innholdet i pakken, slik den ble oppgitt ved opprettelse (f.eks.
`"Medizinisch
    freigestellte Probe"`, `"Home test kit"`). Kun til informasjon — om en pakke skal til et
laboratorium, leses av fra `destination`, og motparten fra `paired_with`. Kan være `null`.

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

Hvem som skrev ut etiketten: `aniva` eller `external`. Bare `aniva`-forsendelser godtar
[Oppdater](https://docs.anivahealth.com/no/api/shipments/update-shipment.md) og [Kanseller](https://docs.anivahealth.com/no/api/shipments/cancel-shipment.md); en
`external`-pakke spores, men returnerer `501` på begge.

**paired\_with** `string`

Referansen til den andre pakken i en topakkeforsendelse – pakken som hadde med en
returetikett, og pakken den etiketten sender tilbake. Satt på begge. `null` for en enveispakke.

**origin** `object`

Henteadresse. Kan være `null`.

**adresseobjekt**

**name** `string` *required*

Navn på mottaker, selskap eller sted.

**company\_name** `string`

Selskap / c/o-linje. Kan være `null`.

**street** `string` *required*

Gatenavn, uten husnummer.

**house\_number** `string`

Husnummer. Kan være `null`.

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

Bygning, inngang eller etasje. Kan være `null`.

**city** `string` *required*

By.

**state** `string`

Delstat eller provins. Kan være `null`.

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

Postnummer.

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

ISO 3166-1 alpha-2-landskode.

**phone** `string`

Kontakttelefonnummer. Kan være `null`.

**email** `string`

Kontakt-e-post. Kan være `null`.

**destination** `object`

Leveringsadresse. Samme struktur som `origin`. Kan være `null`.

**pickup** `object`

Planlagt hentevindu. Kan være `null`.

**pickup-objekt**

**from** `string` *required*

Start på hentevinduet som UTC-tidspunkt (ISO 8601 med `Z`-suffiks).

**till** `string` *required*

Slutt på hentevinduet som UTC-tidspunkt (ISO 8601 med `Z`-suffiks).

**timezone** `string` *required*

IANA-tidssone for hentestedet (f.eks. `Europe/Berlin`). Brukes til å vise `from` / `till` i hentestedets lokale klokketid.

**notes** `string`

Valgfrie notater. Kan være `null`.

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

Kronologiske livssyklushendelser fra logistikkleverandøren (eldste først). Tom liste hvis
leverandøren ikke har rapportert noen hendelser ennå. Bruk dette til brukergrensesnitt per hendelse, revisjon og mer detaljerte
transportørsignaler; bruk `status` for den gjeldende hovedtilstanden.

**Felter for statusoppdatering**

**state** `string | null` *required*

Hendelsen i forsendelsens statusvokabular – `pending`, `in_transit`, `delivered` eller
`fault` – slik at du kan lese en tidslinje uten å kjenne transportørens koder. `null` når
hendelsen ikke har noen tilstand (etikettopprettelse, en skanning uten informasjon fra transportøren, oppføringer registrert
før dette feltet fantes). Aldri `cancelled`.

**code** `string | null` *required*

Transportørens egen statuskode: `GO10` / `GO90` / `GOY001` hos GO!, `VA` / `ZF` / `LA`
/ `ZU` hos DHL. `null` når transportøren ikke oppga noen. Stabil på tvers av språkoversettelser av
`status`.

**detail\_code** `string | null` *required*

Transportørens mer detaljerte kode der den finnes – DHLs `statusDetailed`, f.eks. `CNRFC_NRQRD_ZF`
(omdirigert til postkontor), `HLDCC_SERPT_LA` (klar for henting der), `DLVRD_SERPT_ZU`
(hentet). `null` for transportører uten denne.

**status** `string` *required*

Statusetikett fra leverandøren (fritekst, f.eks. `"Shipment picked up"`,
`"Die Sendung wurde abgeholt."`).

**description** `string | null` *required*

En forklaring av koden, eller transportørens lengre setning. `null` når ingen av delene finnes.

**location** `string | null` *required*

Hvor skanningen skjedde, slik transportøren navngir det – et GO!-depot (`"HUB Niederaula"`) eller en
DHL-by. Fritekst, ikke koordinater. `null` når transportøren ikke rapporterte noe.

**time** `string` *required*

Tidspunktet hendelsen ble registrert (ISO 8601, med tidssoneforskyvningen transportøren rapporterte).

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

Timer knyttet til denne forsendelsen, med eldste kobling først. Hver oppføring er `{ id, added_at }`;
slå opp hver `id` i [Hent time](https://docs.anivahealth.com/no/api/appointments/get-appointment.md) for å få
alle timedataene. Tom liste når ingen timer er tilknyttet.
Bare timene i din tilgangskontekst vises.

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

Bestillinger av hjemmetestsett knyttet til denne forsendelsen, med eldste kobling først, i samme `{ id, added_at }`-format.
Slå opp hver `id` i [Hent bestilling av hjemmetestsett](https://docs.anivahealth.com/no/api/home-kit-orders/get-home-kit.md). Tom
liste for praksispakker. Bare bestillingene i din tilgangskontekst vises. Se
[Tilgang](https://docs.anivahealth.com/no/concepts/shipments.md#tilgang).

**synced\_at** `string`

Når forsendelsen sist ble avstemt med transportøren, som et UTC-tidspunkt. Leseoperasjoner kaller aldri
transportøren – en bakgrunnssynkronisering holder forsendelsene oppdatert – så dette viser hvor gammelt svaret er. `null` frem til
første synkronisering.

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

Tidsstempel for opprettelse (ISO 8601).

**updated\_at** `string`

Tidsstempel for siste oppdatering (ISO 8601). Kan være `null`.

## Gjentatte kall

Aniva lagrer svaret fra dette endepunktet i 5 minutter for hver API-nøkkel. Et gjentatt kall innenfor
denne tiden får det lagrede svaret. Headerne `Cache-Status` og `Age` viser at svaret er
lagret og hvor gammelt det er.

For å få beskjed om en endring med en gang, abonner på webhook-hendelsene `shipment.created` og `shipment.updated`.
Se [Gjentatte lesekall](https://docs.anivahealth.com/no/concepts/webhooks.md#gjentatte-lesinger).

## Feilresponser

| Status | Beskrivelse |
| - | - |
| `400` | Ugyldig spørringsparameter. |
| `403` | Ingen tilgang – manglende tilgangsomfang, eller den filtrerte timen / bestillingen av hjemmetestsett er utenfor ditt tilgangsomfang. |
| `404` | Den filtrerte timen eller bestillingen av hjemmetestsett ble ikke funnet. |
| `500` | Intern serverfeil. |

```bash cURL (all shipments, first page) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/shipments?limit=100&offset=0' \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (one home-kit order) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/shipments?home_kit_order_id=d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a' \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (one appointment, in transit) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/shipments?appointment_id=c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a&status=in_transit' \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
[
  {
    "id": "P2611194821",
    "status": "in_transit",
    "logistics_provider": "go",
    "tracking_number": "GO1234567890",
    "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-15T07:00:00Z",
      "till": "2026-04-15T10:00:00Z",
      "timezone": "Europe/Berlin"
    },
    "notes": null,
    "status_updates": [
      {
        "state": "in_transit",
        "code": "GO10",
        "detail_code": null,
        "status": "Shipment picked up",
        "description": "Picked up at the consignor",
        "location": "Berlin",
        "time": "2026-04-15T09:22:00+02:00"
      },
      {
        "state": "in_transit",
        "code": "GO50",
        "detail_code": null,
        "status": "Receiving station",
        "description": null,
        "location": "HUB Niederaula",
        "time": "2026-04-15T11:18:00+02:00"
      }
    ],
    "appointments": [
      {
        "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
        "added_at": "2026-04-15T08:30:00Z"
      }
    ],
    "home_kit_orders": [],
    "synced_at": "2026-04-15T11:20:00Z",
    "created_at": "2026-04-14T16:00:00Z",
    "updated_at": "2026-04-15T11:20:00Z"
  }
]
```


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