List orders
The order book, newest first: what sold, to whom, and where each order stands.
status filters to one of pending, paid, failed, abandoned, refunded; since (ISO 8601) returns orders created at or after that moment; limit caps the page (default 50, max 200).
q searches reference, customer name, customer email and description across the whole book. offset pages through results; total is the count matching the filters, so offset + limit < total means there is more.
unfulfilled=true returns paid orders whose goods have not gone out: the packing list, ready to poll. Add fulfilment=delivery or fulfilment=collection to split it by how the order leaves.
fulfilled_since (ISO 8601) returns paid orders sent or collected at or after that moment. order=oldest returns the longest-waiting order first (the default is newest).
contact_id (a contact's UUID) returns the orders linked to that contact: a buyer becomes a contact when their order is paid, so this lists one customer's orders even when they gave no email. A malformed id answers 400.
For accounting, paid and refunded are the only statuses that involve money having moved.
Each row is the same shape the commerce.order.* webhooks deliver. Store either, they never disagree.
Request
- Base URL: https://app.blueticked.com
- URL: https://app.blueticked.com/api/v1/commerce/orders
- Auth: HTTP bearer
Query parameters
Filter by status.
Filter by since.
Maximum number of items to return.
Response
Success
Example response
{
"ok": true,
"orders": [
{
"id": "8b43c136-a5d3-4352-99d4-bcf43354c548",
"reference": "BT-ORD-8H2K1",
"number": 1043,
"paystack_reference": "4099260516",
"amount_cents": 45900,
"currency": "ZAR",
"description": "2 items from Aloe Ridge Guest House",
"customer": {
"name": "Naledi Dlamini",
"email": "naledi@example.com",
"phone": "+27800000001"
},
"fulfilment": {
"method": "delivery",
"delivery_address": "12 Protea Rd\nNewlands\nCape Town\n7700",
"delivery_zone": "Southern Suburbs",
"delivery_fee_cents": 6000
},
"discount": {
"code": "WINTER10",
"amount_cents": 4590
},
"items": [
{
"id": "258ab704-cb29-4858-a35d-724d150bc85b",
"product_id": "289e49ce-dfbc-4347-9b4c-52f001f009c3",
"variant_id": "2a85a3c1-a901-49bf-a2a9-71e9d719a994",
"variant_name": "Large",
"name": "Fynbos gift hamper",
"unit_price_cents": 19950,
"quantity": 2
}
],
"site_id": "2503846b-7ed1-42bb-9f5d-f26d5cfdf4a9",
"paid_at": "2026-08-03T09:14:00.000Z",
"created_at": "2026-08-03T09:12:41.000Z"
}
],
"total": 1
}Changes
No recorded changes to this operation across all 1 revision of this API.