Retrieve a shipment

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

{
  "data.reference": "<string>",
  "data.customer": {},
  "data.pickup": {},
  "data.dropoff": {},
  "data.weight_kg": 123,
  "data.distance_km": 123,
  "data.fees": {},
  "data.status": "<string>",
  "data.payment_status": "<string>",
  "data.created_at": "<string>",
  "data.updated_at": "<string>"
}

GET

shipments

{shipment}

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

{
  "data.reference": "<string>",
  "data.customer": {},
  "data.pickup": {},
  "data.dropoff": {},
  "data.weight_kg": 123,
  "data.distance_km": 123,
  "data.fees": {},
  "data.status": "<string>",
  "data.payment_status": "<string>",
  "data.created_at": "<string>",
  "data.updated_at": "<string>"
}

Look up a shipment by its SHP- reference. Unknown references, and shipments that belong to another workspace, return 404.

string

required

Shipment reference, for example SHP-12345.

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

The shipment is wrapped in data:

string

required

Unique SHP- reference.

object

required

id, name, email, and optional id_number.

object

required

address, lat, and lng.

object

required

address, lat, and lng.

number

required

Package weight in kilograms.

number

required

Quoted distance.

object

required

distance, weight, base, total, and currency.

string

required

Delivery status. See Shipment statuses.

string

required

Payment status.

string

required

ISO 8601 timestamp.

string

required

ISO 8601 timestamp.