Get Shipment

GET

api

shipments

{id}

curl --request GET \
  --url https://anivahealth.com/api/v1/shipments/P2604154821 \
  --header 'x-api-key: YOUR_API_KEY'

{
  "id": "P2604154821",
  "status": "in_transit",
  "logistics_provider": "go",
  "tracking_number": "GO123456789",
  "origin": {
    "name": "Aniva Berlin Mitte",
    "street": "Unter den Linden",
    "house_number": "42",
    "postal_code": "10117",
    "city": "Berlin",
    "country": "DE",
    "phone": "+4930987654321",
    "email": "berlin-mitte@anivahealth.com"
  },
  "destination": {
    "name": "LabClinic GmbH",
    "street": "Laborstraße",
    "house_number": "10",
    "postal_code": "80331",
    "city": "München",
    "country": "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": [
    { "status": "Shipment picked up", "time": "2026-04-15T09:42:00Z" },
    { "status": "Receiving station", "time": "2026-04-15T11:18:00Z" }
  ],
  "appointments": [
    {
      "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
      "added_at": "2026-04-15T08:30:00Z"
    }
  ],
  "created_at": "2026-04-03T14:30:00Z",
  "updated_at": "2026-04-15T11:20:00Z"
}

{
  "error": "Shipment not found"
}

Retrieve a single shipment by its reference ID. The endpoint always force-refreshes the shipment from the logistics provider before returning, so the status and status_updates reflect the provider’s latest known state.

Request

Path parameters

string

required

Shipment reference ID (e.g., P2604154821).

Response

On success, the API returns 200 OK with the shipment object.

string

required

Shipment reference identifier.

string

required

Shipment lifecycle status. One of pending, in_transit, delivered, fault, or cancelled.

string

required

Logistics provider. One of go, dhl, or tof.

string

External tracking number from the logistics provider. May be null.

object

Pickup address. May be null.

Show address object

string

required

Company or location name.

string

required

Street name.

string

required

House number.

string

required

Postal/ZIP code.

string

required

City.

string

required

ISO 3166-1 alpha-2 country code.

string

Contact phone number. May be null.

string

Contact email. May be null.

object

Delivery address. Same structure as origin. May be null.

object

Scheduled pickup window. May be null.

Show pickup object

string

required

Start of pickup window as a UTC instant (ISO 8601 with Z suffix).

string

required

End of pickup window as a UTC instant (ISO 8601 with Z suffix).

string

required

IANA timezone of the pickup location (e.g., Europe/Berlin). Use to render from / till in pickup-location wall-clock.

string

Optional notes. May be null.

object[]

required

Chronological lifecycle events from the logistics provider (oldest first). Each entry contains the raw provider-sourced status label and a timestamp. Empty array if the provider has not reported any events yet. Use this for debug / audit; rely on status for canonical current state.

Show status update fields

string

required

Provider-sourced status label (free-form text, e.g. "Shipment picked up", "Loading delivery trip", "Delivered").

string

required

Time the event was observed (ISO 8601).

ShipmentAppointmentLink[]

required

Appointments linked to this shipment, oldest-link first. Empty array when no appointments are linked. Cross-reference each id against Get Appointment for the full appointment payload.

Show Appointment link fields

string

Appointment UUID — cross-reference against Get Appointment.

string

ISO 8601 timestamp the appointment was first linked to this shipment.

string

required

Creation timestamp (ISO 8601).

string

Last update timestamp (ISO 8601). May be null.

Error responses

Status	Description
`400`	Invalid ID format.
`403`	Forbidden — your API key does not have access to this operation or the shipment is outside your access context.
`404`	Shipment not found.
`500`	Internal server error.

curl --request GET \
  --url https://anivahealth.com/api/v1/shipments/P2604154821 \
  --header 'x-api-key: YOUR_API_KEY'

{
  "id": "P2604154821",
  "status": "in_transit",
  "logistics_provider": "go",
  "tracking_number": "GO123456789",
  "origin": {
    "name": "Aniva Berlin Mitte",
    "street": "Unter den Linden",
    "house_number": "42",
    "postal_code": "10117",
    "city": "Berlin",
    "country": "DE",
    "phone": "+4930987654321",
    "email": "berlin-mitte@anivahealth.com"
  },
  "destination": {
    "name": "LabClinic GmbH",
    "street": "Laborstraße",
    "house_number": "10",
    "postal_code": "80331",
    "city": "München",
    "country": "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": [
    { "status": "Shipment picked up", "time": "2026-04-15T09:42:00Z" },
    { "status": "Receiving station", "time": "2026-04-15T11:18:00Z" }
  ],
  "appointments": [
    {
      "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
      "added_at": "2026-04-15T08:30:00Z"
    }
  ],
  "created_at": "2026-04-03T14:30:00Z",
  "updated_at": "2026-04-15T11:20:00Z"
}

{
  "error": "Shipment not found"
}

List Shipments

Update Shipment

curl --request GET \
  --url https://anivahealth.com/api/v1/shipments/P2604154821 \
  --header 'x-api-key: YOUR_API_KEY'

{
  "id": "P2604154821",
  "status": "in_transit",
  "logistics_provider": "go",
  "tracking_number": "GO123456789",
  "origin": {
    "name": "Aniva Berlin Mitte",
    "street": "Unter den Linden",
    "house_number": "42",
    "postal_code": "10117",
    "city": "Berlin",
    "country": "DE",
    "phone": "+4930987654321",
    "email": "berlin-mitte@anivahealth.com"
  },
  "destination": {
    "name": "LabClinic GmbH",
    "street": "Laborstraße",
    "house_number": "10",
    "postal_code": "80331",
    "city": "München",
    "country": "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": [
    { "status": "Shipment picked up", "time": "2026-04-15T09:42:00Z" },
    { "status": "Receiving station", "time": "2026-04-15T11:18:00Z" }
  ],
  "appointments": [
    {
      "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
      "added_at": "2026-04-15T08:30:00Z"
    }
  ],
  "created_at": "2026-04-03T14:30:00Z",
  "updated_at": "2026-04-15T11:20:00Z"
}

{
  "error": "Shipment not found"
}

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

Get Shipment

Request

Path parameters

Response

Error responses

​Request

​Path parameters

​Response

​Error responses

Request

Path parameters

Response

Error responses