What you can do today
Read orders
List and fetch orders across your business with filters by brand, branch,
status, and date range.
Read menus
Pull the menu for one store (with all overrides applied) or for the
business as a whole.
Push availability
Mark items in stock or out of stock, individually or in bulk, with
idempotency keys.
Subscribe to events
Receive
klikit.order.created.v2, klikit.order.status.updated, and
klikit.order.cart.updated events at a URL you host.How the API is shaped
Three things are worth knowing up front:- You authenticate with HTTP Basic. Username is your partner API key, password is the matching secret. See Authentication.
- Every credential is scoped to one business. You cannot read or write anything outside that business — the API enforces it server-side.
- Every response uses the same envelope. Even errors. See Response envelope.
Environments
We don’t run a separate sandbox — the development environment is the
sandbox. See Environments.
Next step
Integration playbook
The phased path from credentials to production. Branched for POS systems
and aggregator marketplaces. Read this first.
Quickstart
Make your first authenticated call, list orders, and verify a webhook in
under 10 minutes.
Authentication
HTTP Basic auth with partner key + secret, scoped per business.
Webhooks integration guide
Stand up a receiver and verify your first event with the reference Node /
Python implementations.