BizKitHub
DocsAPI ReferenceOrder/bff/order/list
getOrderAdmin BFF

/bff/order/list

Returns a paginated list of orders with customer info and attached files. Supports filtering by status, customer, group, date range, payment status, full-text search, overdue (past due-date and unpaid), price range, status type, invoice presence, online-payment outcome, test-account hiding and public-note presence. Pagination is controlled via X-Pagination headers.

OrdergetBffOrderList

Parameters

19 query

Query parameters

· 19
pagestringOptional

Page number (1-based) for pagination.

Example1
limitstringOptional

Maximum items per page (1–500, default 50).

Example50
customerIdstringOptional

Filter by customer external ID.

Example8zLmc498hr0gJb2I
groupCodestringOptional

Filter by order group code.

Exampleeshop
statusCodestringOptional

Filter by order status code.

Examplenew
filterFulltextQuerystringOptional

Full-text search across order number, customer email, first/last name, company name, and phone. Multi-word query: whitespace-separated tokens are AND-ed; each token matches any column (ILIKE, accent-insensitive).

Example26000432
dateFromstringOptional

Filter orders whose chosen date column is on or after this date (inclusive). See dateField for which column is targeted (default: inserted_date).

Example2026-01-01
dateTostringOptional

Filter orders whose chosen date column is on or before this date (inclusive). See dateField for which column is targeted (default: inserted_date).

Example2026-01-31
dateFieldstringOptional

Which date column dateFrom/dateTo apply to: "inserted" (default, created_at), "paid" (paid_at), "updated" (last update), "due" (due_date).

Exampleinserted
isPaidstringOptional

Filter by payment status. "true" = paid only, "false" = unpaid only.

Exampletrue
overduestringOptional

"true" = orders past their due_date and still unpaid (cashflow follow-up); "false" = orders that are either still in time or already paid.

Exampletrue
priceMinstringOptional

Lower bound for the order total price (inclusive). Compared in raw order currency.

Example100
priceMaxstringOptional

Upper bound for the order total price (inclusive). Compared in raw order currency.

Example5000
statusTypestringOptional

Broad status type code – aggregates all org-specific statuses sharing the same type. "new" / "processing" / "done" / "storno".

Exampleprocessing
hasInvoicestringOptional

"true" = order has at least one invoice; "false" = no invoice has been issued yet.

Exampletrue
onlinePaymentResultstringOptional

Aggregated outcome of online payment attempts: "paid" (succeeded), "failed" (cancelled/timeouted, never paid), "pending" (in flight), "none" (no online payment attempt at all).

Examplepaid
hideTestAccountsstringOptional

"true" = exclude orders whose customer is flagged as a test account.

Exampletrue
hasPublicNotestringOptional

"true" = orders with a non-empty public notice (customer wrote a message). "false" = orders without a public notice. Internal notices are not considered.

Exampletrue
tagFilterstringOptional

Comma-separated list of key:value tag pairs (matches the code field on the grid-configuration tag list). Inclusive OR — an order matches if it carries AT LEAST ONE of the listed pairs. Unknown or malformed pairs are silently ignored.

Examplechannel:web

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

GET /bff/order/list

get
curl -X GET "https://api.bizkithub.com/bff/order/list?page=1&limit=50&customerId=8zLmc498hr0gJb2I&groupCode=eshop&statusCode=new&filterFulltextQuery=26000432&dateFrom=2026-01-01&dateTo=2026-01-31&dateField=inserted&isPaid=true&overdue=true&priceMin=100&priceMax=5000&statusType=processing&hasInvoice=true&onlinePaymentResult=paid&hideTestAccounts=true&hasPublicNote=true&tagFilter=channel%3Aweb" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key