Flactrum API
Everything the management panel can do, over HTTP. One deliberate exception: API keys themselves are created only in the panel.
Base URL
https://api.flactrum.com/v1The API lives on its own host. A brand is never identified by the URL — the API key decides whose data comes back, so there is one address for everyone.
Your first call
Create a key in the panel under System → API keys, then:
curl 'https://api.flactrum.com/v1/status' \
-H 'Authorization: Bearer flk_your_key:your_secret'
/status needs no scope. It tells you whether the credentials work,
which brand they belong to and which scopes they carry — which separates
"my credentials are wrong" from "my scopes are wrong".
How the reference is organised
The sections below follow the panel's own menu order, so a screen you know in the panel sits in the same place here. 344 endpoints so far.
Operations
The day-to-day: branch network, shift plan, cash days, checklists and audits.
Panel: Operations → Branch dashboard · Operations → Setup guide · Operations → Branches · Operations → Reservations · Operations → Shifts · Operations → Cash & day-end · Operations → Audits · Operations → Checklists — 52 endpoints
Catalog
The sellable menu and what it produces: products, categories, addons, campaigns, recipes, languages and the orders themselves.
Panel: Menu & products → Menu & products · Menu & products → Product categories · Menu & products → Addon groups · Menu & products → Addons · Menu & products → Campaigns · Menu & products → Coupons · Menu & products → Recipes · Menu & products → Languages & translations · Menu & products → Orders — 65 endpoints
Stock & supply
Raw materials, balances and every document that moves them: counts, transfers, warehouse requests, goods receipts and purchase orders.
Panel: Stock & supply → Stock levels · Stock & supply → Stock items · Stock & supply → Stock item categories · Stock & supply → Purchase units · Stock & supply → Stock counts · Stock & supply → Stock movements · Stock & supply → Warehouses · Stock & supply → Warehouse stock · Stock & supply → Warehouse requests · Stock & supply → Branch transfers · Stock & supply → Goods receipts · Stock & supply → Purchase orders · Stock & supply → Suppliers — 85 endpoints
People & HR
Employees, leave, salaries, payroll and staff expenses.
Panel: Staff & HR → Employees · Staff & HR → Employees → documents · Staff & HR → Leave requests · Staff & HR → Salaries · Staff & HR → Payroll · Staff & HR → Staff expenses — 34 endpoints
Customers & loyalty
Customer accounts, their wallet ledger and the loyalty rules that govern points.
Panel: Customers & loyalty → Customers · Customers & loyalty → Loyalty & points — 10 endpoints
Finance
Income and expense entries, payment methods, and the reports built on top of them.
Panel: Finance → Income & expenses · Finance → Payment methods · Finance → Reports — 28 endpoints
Kiosk
How the self-service kiosk app looks: splash logo and colour theme, per brand with optional branch overrides. Edits go to a draft; kiosks only see what is published.
Panel: Kiosk settings → Appearance & theme · Kiosk settings → Kiosk sales — 18 endpoints
System
Devices, panel users, roles, webhooks, brand settings, billing and the audit log.
Panel: System → Device fleet · System → Users · System → Roles · System → Webhooks · System → API keys · System → Settings · System → Subscription & billing · System → Audit log — 52 endpoints
Before you build
| Authentication | Key formats, rotation, what each 401 means. |
| Requests & responses | Envelope, pagination, incremental sync, language, rate limits. |
| Error codes | The full list. Branch on the code, never the message. |
| Scopes | Exactly the checkboxes shown when a key is created. |