Skip to main content
GET
/
api
/
v1
/
shipments
curl --request GET \
  --url https://anivahealth.com/api/v1/shipments \
  --header 'x-api-key: YOUR_API_KEY'
[
  {
    "id": "P-260415-4821",
    "status": "in_transit",
    "logistics_provider": "go_express",
    "tracking_number": "GO1234567890",
    "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
    },
    "notes": null,
    "shipped_at": "2026-04-15T09:22:00Z",
    "arrived_at": null,
    "created_at": "2026-04-14T16:00:00Z",
    "updated_at": "2026-04-15T09:22:00Z"
  }
]
Retrieve all shipments scoped to your API key’s location groups.
Requires the SHIPMENTS_MANAGE scope. Requests made with a key that lacks this scope return 403 Forbidden.

Request

This endpoint takes no request parameters.

Response

On success, the API returns 200 OK with an array of shipment objects.
id
string
required
Shipment reference identifier.
status
string
required
Shipment lifecycle status. One of pending, shipped, in_transit, delivered, fault, or cancelled.
logistics_provider
string
required
Logistics provider. One of go_express, dhl, or tof.
tracking_number
string
External tracking number from the logistics provider. May be null.
origin
object
Pickup address. May be null.
destination
object
Delivery address. Same structure as origin. May be null.
notes
string
Optional notes. May be null.
shipped_at
string
Actual pickup timestamp (ISO 8601). May be null.
arrived_at
string
Delivery timestamp (ISO 8601). May be null.
created_at
string
required
Creation timestamp (ISO 8601).
updated_at
string
Last update timestamp (ISO 8601). May be null.

Error responses

StatusDescription
403Forbidden — missing SHIPMENTS_MANAGE scope.
500Internal server error.
curl --request GET \
  --url https://anivahealth.com/api/v1/shipments \
  --header 'x-api-key: YOUR_API_KEY'
[
  {
    "id": "P-260415-4821",
    "status": "in_transit",
    "logistics_provider": "go_express",
    "tracking_number": "GO1234567890",
    "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
    },
    "notes": null,
    "shipped_at": "2026-04-15T09:22:00Z",
    "arrived_at": null,
    "created_at": "2026-04-14T16:00:00Z",
    "updated_at": "2026-04-15T09:22:00Z"
  }
]