Respatch API Reference

The Respatch API is a REST interface for deterministic logistics orchestration. All requests require an API key passed as a Bearer token.

Production
https://api.respatch.com
Sandbox
https://sandbox-api.respatch.com

Response Envelope

All responses are JSON. Success responses include a data key. Errors include a message key and appropriate HTTP status code.

Quick start

Delivery orders use a mandatory two-step flow: lock pricing with a quote, then commit with an order referencing that quote.

  1. Get a quote — POST /api/v1/delivery-orders/quote with pickup/dropoff locations and a non-empty packages array (weight and dimensions). Save quote_id and use it before expires_at.
  2. Create an order — POST /api/v1/delivery-orders with quote_id, pickup/dropoff contact info, and per-package metadata. Pricing, vehicle type, and locations come from the quote.

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"
      }
    }
  ]
}