Dropoint for developers

API reference

Base address: https://api.dropoint.co.ke/api/integrations/v1. Header: Authorization: Api-Key <key>. JSON in and out. The same in OpenAPI for code generators and Postman.

Prices#

Method and pathScope
POST /stores/quotes/orders:quotePrice a delivery (guide)
GET /stores/pricing/orders:readDropoint or own prices, Dropoint's share, the price list

Orders#

Method and pathScope
POST /stores/orders/orders:writeSend an order (guide)
GET /stores/orders/orders:readOrders sent to riders
GET /stores/deliveries/orders:readWebsite orders, any stage
GET /stores/orders/{ref}/orders:readOne delivery or order
POST /stores/orders/{ref}/approve/orders:writeApprove
POST /stores/orders/{ref}/ready/orders:writeMark ready for pickup
POST /stores/orders/{ref}/reject/orders:cancelReject before sending
POST /stores/orders/{ref}/cancel/orders:cancelCancel before pickup
POST /stores/test/orders/{ref}/simulate/orders:writeTest keys only: play a step

Wallet and webhooks#

Method and pathScope
GET /stores/wallet/wallet:readBalance, available and held (KES)
GET /stores/webhooks/webhooks:manageThe store's webhooks
POST /stores/webhooks/webhooks:manageAdd one (url, events); the secret is shown once
DELETE /stores/webhooks/{id}/webhooks:manageRemove one

The delivery object#

Field
delivery_idDropoint's id for the delivery, from arrival to the end
reference, order_url, channelWhat you sent
stage, stage_labelawaiting_approval, preparing, ready_blocked, sent, rejected, cancelled, expired, saved
status, status_labelThe order status once sent, else the stage
customer, drop_off, items, order_total, paid_online, cod_amount, fee_paid_byWhat you sent, cleaned
feeamount, priced_by (dropoint or store), held_until (the price promise), final
tracking_urlFor your customer
orderNull until sent; then number, status, delivery_fee, rider, picked_up_at, delivered_at, failure_reason
approved_at, ready_at, created_atWhen
testtrue for test-mode orders
Base address: https://api.dropoint.co.ke/api/integrations/v1 · Questions? Use Support on the store portal.