---
title: "Order totals"
method: GET
path: "/api/v1/commerce/orders/overview"
tags: ["commerce"]
---

# Order totals

`GET /api/v1/commerce/orders/overview`

## Request

- Base URL: `https://app.blueticked.com`
- URL: `https://app.blueticked.com/api/v1/commerce/orders/overview`
- Auth: HTTP bearer

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.

## Response `200`

Success

- object
  - `ok` boolean, required
  - `overview` object, required
    - `total_orders` number, required
    - `to_fulfil` number, required
    - `paid_orders` number, required
    - `refunded_orders` number, required
    - `paid_revenue_cents` number, required
    - `refunded_cents` number, required
    - `last_sale_at` string, nullable, required
    - `to_send` number, required
    - `to_collect` number, required
    - `awaiting_payment` number, required
    - `done_30d` number, required
    - `paid_month_cents` number, required

## Other responses

- `400`: Validation failed
- `401`: Unauthorized: missing or invalid API key
- `402`: Insufficient wallet balance
- `403`: Forbidden: scope, plan limit, or suspension
- `404`: Not found
- `409`: Conflict (idempotency-key reuse or resource in use)
- `422`: Understood but refused: the request is well-formed, the action is not permitted for this resource
- `429`: Rate limited
- `500`: Internal error
- `502`: An upstream provider refused or failed the request
- `503`: Channel or send queue unavailable

---

[API](https://skmtc.dev/blueticked/apis/blueticked-api.md) · [All operations](https://skmtc.dev/blueticked/apis/blueticked-api/llms.txt) · [OpenAPI document](https://skmtc.dev/blueticked/apis/blueticked-api/revisions/07132284f4ff?raw)