API reference

List deliveries

Your company's deliveries, newest first, paged by a cursor rather than an offset — so a page boundary cannot shift underneath you while new bookings arrive.

GET/api/v1/dispatch/deliveries

Query parameters#

limitnumberoptional
How many to return. Default 25, minimum 1, maximum 100. Values outside the range are clamped rather than rejected.
beforestringoptional
An ISO 8601 timestamp. Returns deliveries created strictly before it — pass next_before from the previous page. An unparseable value is a 400 invalid_request.

Request#

curl -G "https://api.rheochat.com/api/v1/dispatch/deliveries" \
  -H "Authorization: Bearer rk_live_YOUR_KEY" \
  --data-urlencode "limit=50"

The next page

curl
curl -G "https://api.rheochat.com/api/v1/dispatch/deliveries" \
  -H "Authorization: Bearer rk_live_YOUR_KEY" \
  --data-urlencode "limit=50" \
  --data-urlencode "before=2026-09-20T09:14:02.118Z"

Response#

200
{
  "environment": "live",
  "livemode": true,
  "data": [
    {
      "id": "0f9a1c8e-…",
      "tracking_code": "DCAB12CD34",
      "reference": "your-order-4821",
      "status": "delivered",
      "payment_status": "paid",
      "delivery_fee": "1800.00",
      "platform_fee": "200.00",
      "distance_km": "4.62",
      "eta_minutes": 26,
      "dropoff_address": "5 Rwang Pam St, Jos",
      "created_at": "2026-09-20T09:14:02.118Z"
    }
  ],
  "has_more": true,
  "next_before": "2026-09-20T09:14:02.118Z",
  "request_id": "b6d3f7c2-…"
}
FieldMeaning
dataThe page: a summary of each delivery, newest first.
has_moreWhether another page exists behind this one.
next_beforeThe cursor for the next page — the created_at of the last row. Null when there is nothing more.
environmentWhich world these rows belong to.

Numbers arrive as strings here

The list returns delivery_fee, platform_fee and distance_km as decimal strings, straight from storage — unlike retrieve, which returns them as numbers. Parse before you do arithmetic. We are not changing it without notice, because doing so silently would break anyone who is already handling it correctly.

What you see#

Only your company's deliveries, and only those in your key's environment. A test key lists test deliveries and nothing else. There is no filter for status, date range or reference yet — page and filter on your side.

Errors#

StatusCodeWhen
400invalid_requestbefore is not a valid ISO 8601 timestamp.
401invalid_api_keyBad or revoked key.

Using it for reconciliation#

Page until you reach a created_at older than your last successful sync, and match rows by the reference you sent at booking. That is what the field is for — it is stored, not merely echoed, so your order id survives on our side.