Skip to main content
DELETE
/
api
/
v1
/
shipments
/
{id}
curl --request DELETE \
  --url https://anivahealth.com/api/v1/shipments/P-260415-4821 \
  --header 'x-api-key: YOUR_API_KEY'

{
  "id": "P-260415-4821",
  "status": "cancelled",
  "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": null,
  "arrived_at": null,
  "created_at": "2026-04-03T14:30:00Z",
  "updated_at": "2026-04-03T16:45:00Z"
}
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.
Requires the SHIPMENTS_MANAGE scope. Requests made with a key that lacks this scope return 403 Forbidden.

​
Request

​
Path parameters

​
id
string
required
Shipment reference ID (e.g., P-260415-4821).

​
Response

On success, the API returns 200 OK with the cancelled shipment object.
​
id
string
required
Shipment reference identifier.
​
status
string
required
Shipment lifecycle status. Will be cancelled after a successful cancellation.
​
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 or shipment outside your access context.
404Shipment not found.
409Shipment cannot be cancelled (already picked up, delivered, or cancelled).
500Internal server error.
curl --request DELETE \
  --url https://anivahealth.com/api/v1/shipments/P-260415-4821 \
  --header 'x-api-key: YOUR_API_KEY'

{
  "id": "P-260415-4821",
  "status": "cancelled",
  "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": null,
  "arrived_at": null,
  "created_at": "2026-04-03T14:30:00Z",
  "updated_at": "2026-04-03T16:45:00Z"
}