> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kasiye.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Quote, create, and manage shipments with the Kasiye workspace API.

Kasiye is a shipping platform for businesses that need to quote, book, and track deliveries from their own systems.

Use the dashboard to create shipments by hand, or the workspace API to book them from your app. Every request is scoped to your workspace. Another team's shipment is never visible to your key.

## What you can do

<Columns cols={2}>
  <Card title="Quote a route" icon="calculator" href="/guides/coverage-and-quotes">
    Check coverage and get distance, weight, and total fees before you book.
  </Card>

  <Card title="Create shipments" icon="box" href="/api-reference/create-shipment">
    Book a covered delivery. PayChangu must be connected on the workspace.
  </Card>

  <Card title="Track and update" icon="truck" href="/api-reference/retrieve-shipment">
    Fetch a shipment by reference, update it while it is unpaid, or cancel it.
  </Card>

  <Card title="Authenticate" icon="key" href="/authentication">
    Call `https://api.kasiye.com/v1` with your workspace secret key (`shp_…`).
  </Card>
</Columns>

## Base URL

All API paths are versioned under `/v1` on the `api` subdomain:

```bash theme={null}
https://api.kasiye.com/v1
```

Local development uses `http://api.localhost:8000/v1`.

## Shipment lifecycle

| Status            | Meaning                         |
| ----------------- | ------------------------------- |
| `pending`         | Created, waiting for payment    |
| `awaiting_pickup` | Paid, waiting for a rider       |
| `in_transit`      | Out for delivery                |
| `delivered`       | Complete                        |
| `cancelled`       | Stopped before delivery started |

Payment is tracked separately: `awaiting_payment`, `paid`, `failed`, or `refunded`.

You can update customer, addresses, and weight only while the shipment is `pending` and `awaiting_payment`. You can cancel while it is `pending` or `awaiting_pickup`.

<Tip>
  New to the API? Start with the [quickstart](/quickstart) — quote a route, then create a shipment in a few requests.
</Tip>