/bff/branch/customers

Returns one DataGrid page of distinct customers (shop__contact) that have at least one shop__order_item attributed to the branch via branch_id. Drives the "Customers" tab grid in apiUrl mode — accepts page, limit, orderBy, filterFulltextQuery. itemCount is the count over the FILTERED set so paginator math is correct. Use /customers-summary for the header total.

BranchgetBffBranchCustomers

Parameters

5 query

5 total

Query · 5

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: firstVisitDate, lastVisitDate, orderCount, itemCount, totalRevenue, name, email.

filterFulltextQuerystring

Free-text search across name, email and phone.

Request

GET /bff/branch/customers

get

curl -X GET "https://api.bizkithub.com/bff/branch/customers?branchSlug=gymroom-plzen&orderBy=lastVisitDate%3Adesc&filterFulltextQuery=example_filterFulltextQuery" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "items": [
    {
      "id": "example_id",
      "name": "example_name",
      "firstName": "example_firstName",
      "lastName": "example_lastName",
      "companyName": "example_companyName",
      "phone": "example_phone",
      "orderCount": 0,
      "itemCount": 0,
      "totalRevenue": 0,
      "lastOrder": {
        "orderNumber": "example_orderNumber",
        "hash": "example_hash"
      },
      "score": 0,
      "accountAgeDays": 0,
      "orderPaid": 0,
      "orderNotPaid": 0,
      "orderNew": 0,
      "orderProcessing": 0,
      "orderStorno": 0,
      "orderDone": 0
    }
  ],
  "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