Cancel a shipment

Cancel a shipment that has not started delivery.

POST /shipments/{shipment}/cancel

Cancel a shipment

cURL

curl --request POST \
  --url https://api.kasiye.com/v1/shipments/{shipment}/cancel \
  --header 'Authorization: Bearer <token>'

Sets status to cancelled. Allowed while the shipment is pending or awaiting_pickup. In-transit and delivered shipments cannot be cancelled.

path.shipment · string · required

Shipment reference, for example SHP-12345.

curl -X POST https://api.kasiye.com/v1/shipments/SHP-12345/cancel \
  -H "Authorization: Bearer shp_your_key"

Returns the cancelled shipment in data.

If the shipment cannot be cancelled:

{
  "message": "This shipment cannot be cancelled.",
  "errors": {
    "shipment": ["This shipment cannot be cancelled."]
  }
}

A reference that belongs to another workspace returns 404.