Cancel a shipment

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

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kasiye.com/v1/shipments/{shipment}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

POST

shipments

{shipment}

cancel

Cancel a shipment

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

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.kasiye.com/v1/shipments/{shipment}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

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.

Getting started

API reference

Guides

Cancel a shipment