/bff/branch/order-items

Returns one DataGrid page of shop__order_item rows whose branch_id resolves to the requested branch. Drives the "Order items" tab grid in apiUrl mode — accepts page, limit, orderBy, filterFulltextQuery and returns { items, itemCount } where itemCount is the count over the FILTERED set so the paginator math is correct. Use /order-items-summary for the header turnover / credit / total-item-count numbers.

BranchgetBffBranchOrder-items

Parameters

7 query

7 total

Query · 7

branchSlugstringRequired

Branch slug.

pagestring | number

Page number (1-based).

Range: 1–∞

limitstring | number

Items per page.

Range: 1–500

orderBystring

Sort directive in field:direction form. Supported fields: activityDate, insertedDate, label, count, price, sale, creditAmount, order, customer.

filterFulltextQuerystring

Free-text search across label, order number and customer fields.

filterMonthstring

Restrict the result to a single calendar month, expressed as YYYY-MM. The cut-off uses the same date dimension as the revenue formula (event.start_time when present, otherwise i.inserted_date), so the filtered turnover matches the corresponding Finance-tab row to the cent. Malformed values are silently ignored.

filterHasCoststring | boolean

When truthy (1, true), restrict the result to rows with a non-zero internal cost (shop__order_item.cost > 0). Same predicate that decides whether a row contributes to the Finance-tab "Variabilní náklady" total, so drilling from that column lands on exactly the rows summed.

Request

GET /bff/branch/order-items

get

curl -X GET "https://api.bizkithub.com/bff/branch/order-items?branchSlug=gymroom-plzen&orderBy=activityDate%3Adesc&filterFulltextQuery=example_filterFulltextQuery&filterMonth=2026-03&filterHasCost=1" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "items": [
    {
      "id": "example_id",
      "label": "example_label",
      "count": 0,
      "price": 0,
      "sale": 0,
      "unit": "example_unit",
      "vat": 0,
      "creditAmount": 0,
      "isStorno": false,
      "order": {
        "orderNumber": "example_orderNumber",
        "hash": "example_hash",
        "statusCode": "example_statusCode"
      },
      "customer": {
        "contactId": "example_contactId",
        "firstName": "example_firstName",
        "lastName": "example_lastName",
        "companyName": "example_companyName"
      }
    }
  ],
  "itemCount": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key