Skip to Content
dzshipBY DZBUILD

dzship API reference

The dzship API reference, generated from the OpenAPI 3.1 spec. Every operation with its request schema, its responses and a request builder.

This reference is generated from /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/ordersCreate a parcel
POST /v1/trackTrack a parcel
POST /v1/ratesQuote delivery and return fees
POST /v1/desksList the stop desks of a courier in one wilaya

Reference data

Operation
GET /v1/couriersEvery courier with its credentials and capabilities
GET /v1/wilayasThe wilayas couriers deliver to
GET /v1/communesThe communes of a wilaya
GET /healthLiveness
GET /statsTotal requests served

For explanations instead of schemas, read the endpoints guide.

Last updated on

On this page