Developer Platform

Build on the BlitzParcel API

Programmatic access to your loads and real-time delivery events. Create loads, pull GPS location snapshots, confirm payments, and subscribe to webhooks — all from your own systems.

Core Endpoints

Everything you need to move loads

Base URL: https://app.blitzparcel.com/api/v1

GET /loads

List Loads

The 50 most recent loads on your account, ordered by creation date.

GET /loads/:unique_code

Get a Load

Full detail for a single load — status, payment status, items, and weight.

POST /loads

Create a Load

Book a pickup and drop-off with a write token. Supports multipart image uploads.

GET /loads/:unique_code/snapshots

Location Snapshots

The ordered list of GPS points recorded while a load is in transit.

GET /loads/:unique_code/payment

Get Payment

Current payment status, service fee, and total amount charged for a load.

POST /loads/:unique_code/payment

Initiate Payment

Start an online payment via Paystack and receive a checkout access code.

Quickstart

Create a load, get notified as it moves

Authenticate with a Bearer token, post a load, then listen for webhook events as a driver picks it up and delivers it.

Create a load POST /loads
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

{
  "load": {
    "pickup_location": "Nairobi CBD",
    "dropoff_location": "Karen Hardy",
    "payment_amount": 100,
    "vehicle_type": "motor_bike",
    "payment_type": "cash_on_delivery",
    "load_type": "small"
  }
}
Webhook event POST your_endpoint
// fired when a driver accepts the load
{
  "event": "load_assigned",
  "data": {
    "unique_code": "5a2be405208ad0f9f7a1",
    "status": "accepted",
    "pickup_location": "Nairobi CBD",
    "dropoff_location": "Karen Hardy",
    "driver": {
      "id": 2,
      "name": "Driver User1"
    }
  }
}
Reference

Auth, credits, errors & events

Authentication

  • Authorization: Bearer TOKEN
  • Create tokens from your dashboard under API Tokens
  • read tokens allow GET & HEAD
  • write tokens allow all methods

Credits

  • Every request deducts 1 credit
  • Failed auth (401) costs nothing
  • 1,000 free credits on every account
  • Empty balance returns 402 Payment Required

Error responses

  • 401 Missing or invalid token
  • 403 Token lacks write permission
  • 404 Resource not found
  • 422 Validation failed

Webhook events

  • load_created, load_assigned
  • load_picked_up, load_delivered
  • load_completed, load_rejected
  • load_returned, payment_confirmed
Getting Started

From sign-up to your first webhook in three steps

1

Create a Developer Account

Sign up and verify your account to unlock the dashboard, including API Tokens and Webhooks.

2

Generate a Token & Call the API

Create a read or write token under API Tokens, then make your first authenticated request.

3

Subscribe to Webhooks

Add your endpoint URL under Webhooks, verify signatures, and start receiving load events live.

Built for Developers

Designed to fit into your stack

REST & JSON

Predictable, resource-based endpoints that return JSON over HTTPS.

Scoped tokens

Read-only or read-write tokens, issued and revoked from your dashboard.

Signed webhooks

Every delivery is HMAC-SHA256 signed so you can verify it came from Blitz.

Usage-based credits

Pay only for the requests you make — 1,000 credits included free.

Start Building

Ready to integrate BlitzParcel?

Create a developer account, generate an API token from your dashboard, and make your first call in minutes. Questions? Email support@blitzparcel.com.