Getting Started
Introduction
Welcome to the Respatch API — book, track, and settle physical deliveries with a single REST surface across sandbox and production.
Building in Node.js or TypeScript? The official SDK wraps these endpoints — cyber-genii/respatch-sdk. Store plugins live at respatch-integrations.
Features
Quotes
Lock fare and vehicle options before you book.
Delivery orders
Create, list, track, and cancel shipments.
Webhooks
Push status events to your backend in real time.
Official SDKs
Node, Python, Go, and Rust default to the public frontiers.
Public frontiers
Integrations and SDKs call these hosts only. The private platform backend is for the Transmit app, admin, and dashboard — never from your API key or SDK.
| Frontier | Host | Keys |
|---|---|---|
| Sandbox (respatch-sandbox) | https://sandbox-api.respatch.com | rsp_*_test_* |
| Production (respatch-api) | https://api.respatch.com | rsp_*_live_* |
Quick start
- Get a quote — POST
/api/v1/delivery-orders/quote - Create an order — POST
/api/v1/delivery-orderswithquote_id
Step 1 — Get Quote
{
"pickup": {
"lat": 6.5244,
"lng": 3.3792
},
"dropoff": {
"address": "12 Admiralty Way, Lekki Phase 1, Lagos"
},
"delivery_type": "express",
"packages": [
{
"weight_kg": 2,
"dimensions_cm": {
"length": 30,
"width": 20,
"height": 5
},
"quantity": 1
}
]
}Step 2 — Create Order
{
"quote_id": "qte_8a91f2c",
"pickup": {
"contact_name": "Jane Sender",
"contact_phone": "+2348012345678",
"contact_email": "jane@example.com"
},
"dropoff": {
"contact_name": "John Receiver",
"contact_phone": "+2348098765432"
},
"packages": [
{
"package_id": "pkg_client_001",
"description": "Documents",
"value": 5000,
"fragile": false,
"supplier_info": {
"name": "Acme Supplies",
"reference": "PO-9921"
}
}
]
}
