Quick start
From nothing to a test delivery in five calls. Use a test-mode key (dpk_test_…), so nothing is charged and no rider moves.
1. Make a key#
The store owner opens the store portal, Developers › API keys › Make a key, ticks the scopes (all of them for now) and switches on Test mode. The key is shown once: keep it secret, like a password.
export DP_KEY="dpk_test_xxxxxxxx_…"
export DP="https://api.dropoint.co.ke/api/integrations/v1/stores"
2. Price the delivery at checkout#
curl -s -X POST "$DP/quotes/" \
-H "Authorization: Api-Key $DP_KEY" -H "Content-Type: application/json" \
-d '{"address": "Argwings Kodhek Rd, Kilimani, Nairobi", "size": "small"}'
{"quote_id": "6f1c…", "fee": "240.00", "currency": "KES", "priced_by": "dropoint",
"vehicle_type": "motorcycle", "expires_at": "2026-11-24T13:20:00+03:00", "distance_km": "4.300"}
Show fee to your customer. Keep quote_id with the order.
3. Send the order#
curl -s -X POST "$DP/orders/" \
-H "Authorization: Api-Key $DP_KEY" -H "Content-Type: application/json" \
-H "Idempotency-Key: WC-1041" \
-d '{"quote_id": "6f1c…", "reference": "WC-1041", "recipient_name": "Achieng Otieno",
"recipient_phone": "0712555101", "address": "Argwings Kodhek Rd, Kilimani",
"items": [{"name": "Ankara dress", "quantity": 2}], "order_total": "6450", "paid_online": true}'
The answer is the delivery. Keep its delivery_id:
{"delivery_id": "b3e2…", "reference": "WC-1041", "stage": "awaiting_approval",
"fee": {"amount": "240.00", "priced_by": "dropoint", "held_until": "…"}, "tracking_url": null, "test": true, "order": null}
4. Approve and mark ready#
The store's staff normally do this on the portal. From your system:
curl -s -X POST "$DP/orders/b3e2…/approve/" -H "Authorization: Api-Key $DP_KEY"
curl -s -X POST "$DP/orders/b3e2…/ready/" -H "Authorization: Api-Key $DP_KEY"
After ready/ the stage is sent and order holds the order number and status.
5. Play the delivery (test keys only)#
curl -s -X POST "$DP/test/orders/b3e2…/simulate/" -H "Authorization: Api-Key $DP_KEY" \
-H "Content-Type: application/json" -d '{"event": "assigned"}'
# then "picked_up", then "delivered" (or "failed")
Each step sends your webhooks a message marked "test": true. The store owner can also press the buttons on Developers › Test orders.
Make a normal key (Test mode off), swap it in, and that's all. Live keys start dpk_live_.