/bff/branch/customers-summary

Returns the total count of distinct customers attached to the branch via shop__order_item.branch_id. Drives the header above the paginated /customers grid.

BranchgetBffBranchCustomers-summary

Parameters

1 query

Query parameters

· 1

branchSlugstringRequired

Branch slug.

Examplegymroom-plzen

Response schema

1 status code documented

200Success

branchIdstringRequired

branchSlugstringRequired

branchNamestringRequired

itemCountnumberRequired

Response example

application/json

{
  "branchId": "example_branchId",
  "branchSlug": "example_branchSlug",
  "branchName": "example_branchName",
  "itemCount": 0
}

Request example

GET /bff/branch/customers-summary

get

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