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

# Uzskaitīt sūtījumus

> Iegūt sūtījumus, filtrējot pēc pieraksta, mājas komplekta pasūtījuma vai statusa

Iegūsti tavai API atslēgai pieejamos sūtījumus, sākot ar jaunāko. Šajā vienā sarakstā ir katra paka:
kurjera paņemšana no prakses, komplekts ceļā pie mājas testa komplekta pacienta un paraugs ceļā
atpakaļ. Filtrē pēc viena vecākobjekta ar `appointment_id` vai `home_kit_order_id`.

Nepieciešams `shipments_view` vai `shipments_manage` tvērums.

Atbilde nāk no mūsu datubāzes un nekad nesazinās ar pārvadātāju. Fona sinhronizācija atsvaidzina katru
sūtījumu (ik pēc 10 minūtēm GO!, reizi stundā DHL), un `synced_at` katrā rindā parāda, kad
pārvadātājam pēdējo reizi tika vaicāts.

## Pieprasījums

### Vaicājuma parametri

**appointment\_id** `string`

Tikai ar šo pierakstu saistītie sūtījumi (UUID). `404`, ja pieraksts neeksistē, `403`,
ja tas ir ārpus tava piekļuves konteksta.

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

Tikai ar šo mājas testa komplekta pasūtījumu saistītie sūtījumi (UUID). Parasti tiek atgrieztas divas rindas — komplekts ceļā
pie pacienta un paraugs atpakaļ uz laboratoriju (tā `destination` ir laboratorija). Tādi paši
`404` / `403` noteikumi kā `appointment_id`.

**status** `string`

Tikai sūtījumi šajā statusā. Viena no vērtībām: `pending`, `in_transit`, `delivered`, `fault`, `cancelled`.

**limit** `integer`

Maksimālais atgriežamo sūtījumu skaits. Noklusējums 100, maksimums 500.

**offset** `integer`

Izlaisto sūtījumu skaits. Noklusējums 0. Kārtošana ir stabila (`created_at` dilstošā secībā, tad
atsauce), tāpēc lapas nepārklājas.

## Atbilde

Veiksmes gadījumā API atgriež `200 OK` ar sūtījumu objektu masīvu.

**id** `string` *required*

Sūtījuma atsauces identifikators.

**status** `string` *required*

Sūtījuma dzīves cikla statuss. Viena no šīm vērtībām: `pending`, `in_transit`, `delivered`, `fault` vai `cancelled`.

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

Loģistikas pakalpojumu sniedzējs. Viena no vērtībām: `go`, `dhl_parcel`, `dhl_warenpost`, `rotrunner`, `rapido`,
`ups` vai `dhl_express`. Mājas komplekta paka ir `dhl_parcel` vai `dhl_warenpost`, ja tā dodas uz ārzemēm
kā Warenpost International.

**tracking\_number** `string`

Loģistikas pakalpojumu sniedzēja ārējais izsekošanas numurs. Var būt `null`.

**contents** `string`

Brīva teksta apraksts par pakas saturu, kā norādīts izveides brīdī (piem., `"Medizinisch
    freigestellte Probe"`, `"Home test kit"`). Tikai informatīvs — to, vai paka dodas uz
laboratoriju, nolasa no `destination`, bet tās pāri no `paired_with`. Var būt `null`.

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

Kas izdrukāja uzlīmi: `aniva` vai `external`. Tikai `aniva` sūtījumi atbalsta
[Atjaunināt](https://docs.anivahealth.com/lv/api/shipments/update-shipment.md) un [Atcelt](https://docs.anivahealth.com/lv/api/shipments/cancel-shipment.md); `external`
paka tiek izsekota, bet abos gadījumos atgriež `501`.

**paired\_with** `string`

Otras pakas atsauce divu paku sūtījumā — paka, kurā bija atpakaļsūtīšanas
uzlīme, un paka, kas ar šo uzlīmi tiek nosūtīta atpakaļ. Norādīta abām. `null` vienvirziena pakai.

**origin** `object`

Paņemšanas adrese. Var būt `null`.

**adreses objekts**

**name** `string` *required*

Saņēmēja, uzņēmuma vai atrašanās vietas nosaukums.

**company\_name** `string`

Uzņēmuma / c/o rinda. Var būt `null`.

**street** `string` *required*

Ielas nosaukums bez mājas numura.

**house\_number** `string`

Mājas numurs. Var būt `null`.

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

Ēka, ieeja vai stāvs. Var būt `null`.

**city** `string` *required*

Pilsēta.

**state** `string`

Štats vai province. Var būt `null`.

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

Pasta indekss.

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

ISO 3166-1 alpha-2 valsts kods.

**phone** `string`

Kontakttālruņa numurs. Var būt `null`.

**email** `string`

Kontakta e-pasts. Var būt `null`.

**destination** `object`

Piegādes adrese. Tāda pati struktūra kā `origin`. Var būt `null`.

**pickup** `object`

Ieplānotais paņemšanas laika logs. Var būt `null`.

**pickup objekts**

**from** `string` *required*

Paņemšanas laika loga sākums kā UTC laika punkts (ISO 8601 ar `Z` sufiksu).

**till** `string` *required*

Paņemšanas laika loga beigas kā UTC laika punkts (ISO 8601 ar `Z` sufiksu).

**timezone** `string` *required*

Paņemšanas vietas IANA laika josla (piem., `Europe/Berlin`). Izmanto, lai parādītu `from` / `till` paņemšanas vietas vietējā laikā.

**notes** `string`

Neobligātas piezīmes. Var būt `null`.

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

Hronoloģiski dzīves cikla notikumi no loģistikas pakalpojumu sniedzēja (vecākie vispirms). Tukšs masīvs, ja
pakalpojumu sniedzējs vēl nav ziņojis par notikumiem. Izmanto to saskarnei pa notikumiem, auditam un detalizētākiem pārvadātāja
signāliem; noteicošajam pašreizējam stāvoklim paļaujies uz `status`.

**statusa atjauninājuma lauki**

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

Notikums sūtījuma statusu vārdnīcā — `pending`, `in_transit`, `delivered` vai
`fault` —, lai tu varētu izlasīt notikumu gaitu, nezinot pārvadātāja kodus. `null`, ja
notikumam nav stāvokļa (uzlīmes izveide, pārvadātāja skenējums bez informācijas, ieraksti, kas reģistrēti
pirms šī lauka parādīšanās). Nekad nav `cancelled`.

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

Pārvadātāja paša statusa kods: GO! `GO10` / `GO90` / `GOY001`, DHL `VA` / `ZF` / `LA`
/ `ZU`. `null`, ja pārvadātājs to nenorādīja. Nemainās atkarībā no
`status` tulkojuma valodas.

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

Pārvadātāja detalizētāks kods, ja tāds ir — DHL `statusDetailed`, piemēram, `CNRFC_NRQRD_ZF`
(novirzīts uz pasta nodaļu), `HLDCC_SERPT_LA` (gatavs saņemšanai tur), `DLVRD_SERPT_ZU`
(saņemts). `null` pārvadātājiem bez šāda koda.

**status** `string` *required*

Pakalpojumu sniedzēja norādītais statusa nosaukums (brīvas formas teksts, piemēram, `"Shipment picked up"`,
`"Die Sendung wurde abgeholt."`).

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

Koda skaidrojums vai pārvadātāja garāks teikums. `null`, ja nav neviena no tiem.

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

Vieta, kur notika skenēšana, kā to nosauc pārvadātājs — GO! depo (`"HUB Niederaula"`) vai
DHL pilsēta. Brīvs teksts, nevis koordinātas. `null`, ja pārvadātājs to nenorādīja.

**time** `string` *required*

Laiks, kad notikums tika fiksēts (ISO 8601 formātā, ar pārvadātāja norādīto laika nobīdi).

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

Ar šo sūtījumu saistītie pieraksti, sākot ar vecāko saiti. Katrs ieraksts ir `{ id, added_at }`;
pārbaudi katru `id` ar [Iegūt pierakstu](https://docs.anivahealth.com/lv/api/appointments/get-appointment.md), lai iegūtu
pilnus pieraksta datus. Tukšs masīvs, ja nav saistītu pierakstu.
Ir uzskaitīti tikai tie pieraksti, kas ir tavā piekļuves kontekstā.

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

Ar šo sūtījumu saistītie mājas testa komplektu pasūtījumi tādā pašā `{ id, added_at }` formā, sākot ar vecāko saiti.
Pārbaudi katru `id` ar [Iegūt mājas testa komplekta pasūtījumu](https://docs.anivahealth.com/lv/api/home-kit-orders/get-home-kit.md). Tukšs
masīvs prakses pakām. Ir uzskaitīti tikai tie pasūtījumi, kas ir tavā piekļuves kontekstā. Skati
[Piekļuve](https://docs.anivahealth.com/lv/concepts/shipments.md#piekluve).

**synced\_at** `string`

Laiks UTC formātā, kad sūtījums pēdējo reizi tika salāgots ar pārvadātāju. Lasīšanas pieprasījumi nekad nesazinās ar
pārvadātāju — sūtījumus atjaunina fona sinhronizācija —, tāpēc šis rāda, cik veca ir atbilde. `null` līdz
pirmajai sinhronizācijai.

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

Izveides laikspiedols (ISO 8601).

**updated\_at** `string`

Pēdējās atjaunināšanas laikspiedols (ISO 8601). Var būt `null`.

## Atkārtoti izsaukumi

Aniva saglabā šī galapunkta atbildi 5 minūtes katrai API atslēgai. Atkārtots izsaukums šajā
laikā saņem saglabāto atbildi. Galvenes `Cache-Status` un `Age` rāda, ka atbilde ir
saglabāta un cik veca tā ir.

Lai par izmaiņām uzzinātu uzreiz, abonē webhook notikumus `shipment.created` un `shipment.updated`.
Skati [Atkārtota lasīšana](https://docs.anivahealth.com/lv/concepts/webhooks.md#atkartota-nolasisana).

## Kļūdu atbildes

| Statuss | Apraksts |
| - | - |
| `400` | Nederīgs vaicājuma parametrs. |
| `403` | Aizliegts — trūkst tvēruma, vai arī filtrētais pieraksts / mājas testa komplekta pasūtījums ir ārpus tava tvēruma. |
| `404` | Filtrētais pieraksts vai mājas testa komplekta pasūtījums nav atrasts. |
| `500` | Iekšēja servera kļūda. |

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