Following deliveries
Use webhooks to hear about changes as they happen. Read a delivery when you need its latest state.
One delivery#
GET https://api.dropoint.co.ke/api/integrations/v1/stores/orders/{ref}/ (scope orders:read). ref can be the delivery_id, the Dropoint order id or the order number (DRP-…).
Website orders#
GET https://api.dropoint.co.ke/api/integrations/v1/stores/deliveries/ lists website orders in every stage, newest first. Filters: stage, reference (your order number), since (ISO time: changed since), page.
All the store's orders#
GET https://api.dropoint.co.ke/api/integrations/v1/stores/orders/ lists orders sent to riders (from your site, the portal or the app). Filters: status (a status or active, searching, on_the_way, delivered, problems, cancelled), since, page. Each row has delivery_id and reference when it came from your site.
Order status#
Once stage is sent, order.status moves on:
order.status | Meaning |
|---|---|
broadcasting | Finding a rider |
assigned | Rider on the way to the shop (order.rider has the name and phone) |
en_route_pickup, arrived_pickup | Rider coming / at the shop |
picked_up, in_transit, arrived_delivery | On the way / at the customer |
delivered | Done. The customer gave the rider their delivery code. |
failed | Couldn't deliver (failure_reason); the parcel comes back |
returning, returned | Coming back / back at the shop |
cancelled | Cancelled (cancellation_reason) |
Tracking link#
Every delivery has a tracking_url for your customer: put it in your order email or "My orders" page. It shows the store preparing the order, then the rider live on a map. Stores can also have Dropoint text it to the customer.