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

19 total

Query · 19

pagestring

Page number (1-based) for pagination.

limitstring

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

customerIdstring

Filter by customer external ID.

groupCodestring

Filter by order group code.

statusCodestring

Filter by order status code.

filterFulltextQuerystring

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).

dateFromstring

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

dateTostring

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

dateFieldstring

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

isPaidstring

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

overduestring

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

priceMinstring

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

priceMaxstring

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

statusTypestring

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

hasInvoicestring

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

onlinePaymentResultstring

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

hideTestAccountsstring

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

hasPublicNotestring

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

tagFilterstring

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.

Request

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"

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key