Order totals
The order book's headline numbers (counts, revenue and last sale), computed over every order in one call.
Computed in the database over the whole book, never derived from a page of /orders, so it stays exact at any order count.
to_fulfil is paid orders with a fulfilment method chosen and nothing sent yet: the packing list's size.
refunded_cents sits beside revenue rather than being subtracted from it, so both figures reconcile against Paystack as-is.
The day's work, each the length of its /orders filter: to_send (paid, delivery, not sent: unfulfilled=true&fulfilment=delivery), to_collect (the same for collection), awaiting_payment (status=pending) and done_30d (sent or collected in the last 30 days: fulfilled_since).
paid_month_cents is the money paid since midnight on the 1st of this month, South African time, summed over every paid order.
Request
- Base URL: https://app.blueticked.com
- URL: https://app.blueticked.com/api/v1/commerce/orders/overview
- Auth: HTTP bearer
Response
Success
Example response
{
"ok": true,
"overview": {
"total_orders": 10234,
"to_fulfil": 3,
"paid_orders": 9411,
"refunded_orders": 87,
"paid_revenue_cents": 184039550,
"refunded_cents": 1220050,
"to_send": 2,
"to_collect": 1,
"awaiting_payment": 4,
"done_30d": 318,
"paid_month_cents": 4128050
}
}Changes
No recorded changes to this operation across all 1 revision of this API.