Cancel Shipment

DELETE

api

shipments

{id}

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

{
  "id": "P2604154821",
  "status": "cancelled",
  "logistics_provider": "go",
  "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
  },
  "pickup": {
    "from": "2026-04-15T07:00:00Z",
    "till": "2026-04-15T10:00:00Z",
    "timezone": "Europe/Berlin"
  },
  "notes": null,
  "status_updates": [],
  "appointments": [],
  "created_at": "2026-04-03T14:30:00Z",
  "updated_at": "2026-04-03T16:45:00Z"
}

{
  "error": "Shipment cannot be cancelled after pickup"
}

{
  "error": "Shipment not found"
}

{
  "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
}

Cancel a shipment order. This calls the logistics provider API to cancel the order and updates the shipment status to cancelled.

Shipments cannot be cancelled after pickup. Attempting to cancel a shipment that has already been picked up, delivered, or previously cancelled returns 409 Conflict.

Request

Path parameters

string

required

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

Response

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

string

required

Shipment reference identifier.

string

required

Shipment lifecycle status. Will be cancelled after a successful cancellation.

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 (ISO 8601 with timezone offset).

string

required

End of pickup window (ISO 8601 with timezone offset).

string

required

IANA timezone of the pickup location (e.g., Europe/Berlin).

string

Optional notes. May be null.

object[]

required

Chronological lifecycle events from the logistics provider (oldest first). Each entry has a status (free-form provider-sourced label) and time (ISO 8601). Empty array if no events observed yet.

ShipmentAppointmentLink[]

required

Appointments that were linked to this shipment before cancellation. Each entry is { id, added_at }; cross-reference each id against Get Appointment.

string

required

Creation timestamp (ISO 8601).

string

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

Error responses

Status	Description
`403`	Forbidden — your API key does not have access to this operation or the shipment is outside your access context.
`404`	Shipment not found.
`409`	Shipment cannot be cancelled (already picked up, delivered, or cancelled).
`500`	Internal server error.
`502`	Logistics provider rejected the request (e.g., cancellation deadline exceeded). Includes the provider’s error message.

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

{
  "id": "P2604154821",
  "status": "cancelled",
  "logistics_provider": "go",
  "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
  },
  "pickup": {
    "from": "2026-04-15T07:00:00Z",
    "till": "2026-04-15T10:00:00Z",
    "timezone": "Europe/Berlin"
  },
  "notes": null,
  "status_updates": [],
  "appointments": [],
  "created_at": "2026-04-03T14:30:00Z",
  "updated_at": "2026-04-03T16:45:00Z"
}

{
  "error": "Shipment cannot be cancelled after pickup"
}

{
  "error": "Shipment not found"
}

{
  "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
}

Update Shipment

List Shipment Appointments

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

{
  "id": "P2604154821",
  "status": "cancelled",
  "logistics_provider": "go",
  "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
  },
  "pickup": {
    "from": "2026-04-15T07:00:00Z",
    "till": "2026-04-15T10:00:00Z",
    "timezone": "Europe/Berlin"
  },
  "notes": null,
  "status_updates": [],
  "appointments": [],
  "created_at": "2026-04-03T14:30:00Z",
  "updated_at": "2026-04-03T16:45:00Z"
}

{
  "error": "Shipment cannot be cancelled after pickup"
}

{
  "error": "Shipment not found"
}

{
  "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
}

Health

Profiles

Appointments

Home Kit Orders

Biomarkers

Panels

Units

Locations

Documents

Shipments

Cancel Shipment

Request

Path parameters

Response

Error responses

​Request

​Path parameters

​Response

​Error responses

Request

Path parameters

Response

Error responses