# dzship API reference

> Index of every page: https://freeship.dzbuild.com/llms.txt

Source: https://freeship.dzbuild.com/docs/api

This reference is generated from [`/openapi.json`](https://freeship.dzbuild.com/openapi.json), the OpenAPI 3.1 description
of the API. Each page shows one operation with its request schema, its responses and code
samples, and lets you send the request from the page.

The base URL is `https://freeship.dzbuild.com`. Bodies and responses are JSON. There is no
authentication header: courier credentials travel in the request body.

> **Try requests with the sandbox**
> Set `courier` to `sandbox` and leave `credentials` out. The sandbox validates the request
> and creates nothing. Real courier credentials belong on your server, not in a browser.

## Shipping

| Operation | |
|---|---|
| [`POST /v1/orders`](https://freeship.dzbuild.com/docs/api/shipping/createOrder.md) | Create a parcel |
| [`POST /v1/track`](https://freeship.dzbuild.com/docs/api/shipping/track.md) | Track a parcel |
| [`POST /v1/rates`](https://freeship.dzbuild.com/docs/api/shipping/rates.md) | Quote delivery and return fees |
| [`POST /v1/desks`](https://freeship.dzbuild.com/docs/api/shipping/desks.md) | List the stop desks of a courier in one wilaya |

## Reference data

| Operation | |
|---|---|
| [`GET /v1/couriers`](https://freeship.dzbuild.com/docs/api/reference/couriers.md) | Every courier with its credentials and capabilities |
| [`GET /v1/wilayas`](https://freeship.dzbuild.com/docs/api/reference/wilayas.md) | The wilayas couriers deliver to |
| [`GET /v1/communes`](https://freeship.dzbuild.com/docs/api/reference/communes.md) | The communes of a wilaya |
| [`GET /health`](https://freeship.dzbuild.com/docs/api/reference/health.md) | Liveness |
| [`GET /stats`](https://freeship.dzbuild.com/docs/api/reference/stats.md) | Total requests served |

For explanations instead of schemas, read the [endpoints guide](https://freeship.dzbuild.com/docs/endpoints.md).