BizKitHub
DocsAPI ReferenceBranch/bff/branch/order-items
getBranchAdmin BFF

/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

Query parameters

· 7
branchSlugstringRequired

Branch slug.

Examplegymroom-plzen
pagestring | numberOptional

Page number (1-based).

Range: 1–∞
limitstring | numberOptional

Items per page.

Range: 1–500
orderBystringOptional

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

ExampleactivityDate:desc
filterFulltextQuerystringOptional

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

Exampleexample_filterFulltextQuery
filterMonthstringOptional

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.

Example2026-03
filterHasCoststring | booleanOptional

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.

Example1

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired

External item id ("hash_internalId") for cross-references.

labelstringRequired
countnumberRequired
pricenumberRequired

Unit price in the order currency.

salenumberRequired

Per-line discount in the order currency.

unitstringOptional
vatnumberOptional
creditAmountnumberRequired
costnumber | nullRequired

Snapshotted per-unit internal cost in the order currency at the moment this line was created (variant.cost ?? product.cost, FX-converted from the org default). Informational on the branch grid — shows what the line cost the organisation at the time it was booked. Null means the cost was not resolvable at creation time (no variant/product cost on record or no FX rate available).

One of 2:
Variant 1
number
Variant 2
null
realMoneyPricenumber | nullRequired

Per-line MONEY the customer actually paid for this row after the order rule engine (vouchers + customer credits proportionally allocated). Null means the row is a virtual deduction line (no money attribution) OR the value has not been backfilled yet for this legacy row. Branch revenue is the SUM of this column over non-storno rows.

One of 2:
Variant 1
number
Variant 2
null
isStornobooleanRequired
insertedDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
activityDateDate | string | string | numberRequired

Date this row is bucketed on — event.start_time when the underlying shop__order_item references a calendar event (gym lesson, appointment), otherwise i.inserted_date. The grid sorts and the Finance tab buckets by this same value.

One of 4:
Variant 1
Date

Date this row is bucketed on — event.start_time when the underlying shop__order_item references a calendar event (gym lesson, appointment), otherwise i.inserted_date. The grid sorts and the Finance tab buckets by this same value.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
orderobjectRequired
orderNumberstringRequired
hashstringRequired
payDateDate | string | string | numberOptional
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
statusCodestringOptional
customerobjectOptional
contactIdstringRequired
firstNamestringOptional
lastNamestringOptional
companyNamestringOptional
itemCountnumberRequired

Total number of items matching the current filter — paginator denominator.

Response example

application/json
{
  "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
}

Request example

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"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key