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 path | Scope | |
|---|---|---|
POST /stores/quotes/ | orders:quote | Price a delivery (guide) |
GET /stores/pricing/ | orders:read | Dropoint or own prices, Dropoint's share, the price list |
Orders#
| Method and path | Scope | |
|---|---|---|
POST /stores/orders/ | orders:write | Send an order (guide) |
GET /stores/orders/ | orders:read | Orders sent to riders |
GET /stores/deliveries/ | orders:read | Website orders, any stage |
GET /stores/orders/{ref}/ | orders:read | One delivery or order |
POST /stores/orders/{ref}/approve/ | orders:write | Approve |
POST /stores/orders/{ref}/ready/ | orders:write | Mark ready for pickup |
POST /stores/orders/{ref}/reject/ | orders:cancel | Reject before sending |
POST /stores/orders/{ref}/cancel/ | orders:cancel | Cancel before pickup |
POST /stores/test/orders/{ref}/simulate/ | orders:write | Test keys only: play a step |
Wallet and webhooks#
| Method and path | Scope | |
|---|---|---|
GET /stores/wallet/ | wallet:read | Balance, available and held (KES) |
GET /stores/webhooks/ | webhooks:manage | The store's webhooks |
POST /stores/webhooks/ | webhooks:manage | Add one (url, events); the secret is shown once |
DELETE /stores/webhooks/{id}/ | webhooks:manage | Remove one |
The delivery object#
| Field | |
|---|---|
delivery_id | Dropoint's id for the delivery, from arrival to the end |
reference, order_url, channel | What you sent |
stage, stage_label | awaiting_approval, preparing, ready_blocked, sent, rejected, cancelled, expired, saved |
status, status_label | The order status once sent, else the stage |
customer, drop_off, items, order_total, paid_online, cod_amount, fee_paid_by | What you sent, cleaned |
fee | amount, priced_by (dropoint or store), held_until (the price promise), final |
tracking_url | For your customer |
order | Null until sent; then number, status, delivery_fee, rider, picked_up_at, delivered_at, failure_reason |
approved_at, ready_at, created_at | When |
test | true for test-mode orders |