Quickstart

Go from zero to a fully simulated delivery in about five minutes. The sandbox requires no KYC, no card and no real riders.

1 · Get a sandbox key

Create an organization at enterprise.quickliapp.com/signup, verify your email, then generate a test key in the portal. Test keys are prefixed qk_test_ and only work against sandbox data.

setup.sh
# 1. Sign up at enterprise.quickliapp.com/signup
# 2. Verify your email — sandbox unlocks instantly
# 3. Portal → API Keys → "Create key" (environment: Test)
# Your key looks like:  qk_test_7Qm3Xk9pLw2Zr8Tt…

2 · Price the delivery first

Estimates cost 1 token and never dispatch a rider. Use them to show shipping options in your own checkout before committing.

estimate.sh
curl -X POST https://api.quickliapp.com/v1/open/deliveries/estimate \
  -H "Authorization: Bearer qk_test_7Qm3Xk9p…" \
  -H "Content-Type: application/json" \
  -d '{
    "pickup":  { "lat": 6.4412, "lng": 3.4311, "address": "Victoria Island, Lagos" },
    "dropoff": { "lat": 6.4531, "lng": 3.3952, "address": "12 Awolowo Rd, Ikoyi, Lagos" },
    "package": { "size": "small", "weightKg": 1.2 },
    "options": { "deliveryOption": "Standard" }
  }'
response.json
{
  "deliveryFee": 1250.00,
  "serviceFee": 125.00,
  "vat": 103.13,
  "totalPayable": 1478.13,
  "eta": { "pickupMinutes": 12, "deliveryMinutes": 35 },
  "inServiceArea": true,
  "quoteValidFor": 300
}

3 · Dispatch

Creating a delivery costs 5 tokens plus the quoted delivery fee from your wallet (sandbox wallet is pre-funded with ₦100,000 test credit). Always send an Idempotency-Key on POSTs so retries can never double-dispatch.

dispatch.sh
curl -X POST https://api.quickliapp.com/v1/open/deliveries \
  -H "Authorization: Bearer qk_test_7Qm3Xk9p…" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "package",
    "externalId": "MY-FIRST-TEST",
    "pickup":  { "lat": 6.4412, "lng": 3.4311, "address": "Victoria Island, Lagos" },
    "dropoff": {
      "recipient": { "name": "Test Recipient", "phone": "+2348000000000" },
      "location":  { "lat": 6.4531, "lng": 3.3952, "address": "12 Awolowo Rd, Ikoyi, Lagos" }
    },
    "package": { "description": "Documents", "size": "small", "weightKg": 1.2, "declaredValue": 10000 },
    "options": { "deliveryOption": "Standard", "proofOfDelivery": true },
    "paymentMethod": "wallet"
  }'
response.json
{
  "id": "dlv_01J8ZK3M…",
  "orderId": "QK-TEST-000482",
  "status": "rider:searching",
  "pricing": { "deliveryFee": 1250, "serviceFee": 125, "vat": 103.13, "totalPayable": 1478.13 },
  "eta": { "pickupMinutes": 12, "deliveryMinutes": 35 },
  "trackingUrl": "https://quickliapp.com/track/QK-TEST-000482"
}

4 · Track to completion

Poll the tracking endpoint, or — much better — register a webhook endpoint in the portal and receive delivery.status_changed events as they happen. In the sandbox a simulated rider completes the whole lifecycle in about two minutes.

track.sh
curl https://api.quickliapp.com/v1/open/deliveries/dlv_01J8ZK3M…/tracking \
  -H "Authorization: Bearer qk_test_7Qm3Xk9p…"

# Sandbox riders advance automatically:
# rider:searching → rider:accepted → rider:at-vendor →
# rider:picked-up-order → rider:in-transit → rider:arrived →
# rider:dropped-off-order → completed   (~2 minutes total)

You're live in the sandbox

Next steps: register a webhook endpoint, publish your first product, then complete KYC in the portal to unlock live keys and real rider dispatch.

What happens at go-live?

  • Complete business verification (CAC documents + owner ID) in the portal — reviewed within ~24 hours.
  • Fund your delivery wallet via card or bank transfer (Paystack).
  • Choose a plan. Your first live key is created with the scopes you select.
  • Same endpoints, same payloads — swap qk_test_ for qk_live_ and real riders take it from there.