/bff/branch/order-items-summary

Returns the headline numbers (total turnover, total credit balance, total item count, currency, branch name) over EVERY shop__order_item attributed to the branch. Independent of pagination — drives the header above the paginated /order-items grid. Franchise economics use the rate effective on the LAST day of the filtered month (or today when no month filter is set), looked up from shop__branch_franchise_fee; when no rule covers that day the fee fields are omitted so the admin hides the franchise row.

BranchgetBffBranchOrder-items-summary

Parameters

2 query

Query parameters

· 2

branchSlugstringRequired

Branch slug.

Examplegymroom-plzen

filterMonthstringOptional

Restrict the summary to a single calendar month, expressed as YYYY-MM. Uses the same revenue-date predicate as /order-items, so the headline turnover matches the filtered grid below. Malformed values are silently ignored.

Example2026-03

Response schema

1 status code documented

200Success

branchIdstringRequired

branchSlugstringRequired

branchNamestringRequired

currencystringRequired

ISO 4217 code of the organisation default currency.

totalPriceMoneynumberRequired

totalCreditAmountnumberRequired

itemCountnumberRequired

franchiseFeePercentagenumberOptional

Franchise fee skimmed off turnover, in percent. Omitted when not configured.

franchiseFeeAmountnumberOptional

totalPriceMoney × franchiseFeePercentage ÷ 100, rounded. Omitted when not configured.

franchiseFeeRemaindernumberOptional

totalPriceMoney − franchiseFeeAmount. Omitted when not configured.

Response example

application/json

{
  "branchId": "example_branchId",
  "branchSlug": "example_branchSlug",
  "branchName": "example_branchName",
  "currency": "example_currency",
  "totalPriceMoney": 0,
  "totalCreditAmount": 0,
  "itemCount": 0,
  "franchiseFeePercentage": 0,
  "franchiseFeeAmount": 0,
  "franchiseFeeRemainder": 0
}

Request example

GET /bff/branch/order-items-summary

get

curl -X GET "https://api.bizkithub.com/bff/branch/order-items-summary?branchSlug=gymroom-plzen&filterMonth=2026-03" \
  -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