Understand the MiniTill Developer API

Overview

• MiniTill exposes a versioned public REST API under /api/v1 for supported business/server workflows.
• Current public coverage includes Catalogue, Stores, Orders, Payments, Customers, Loyalty, Gift Cards, Vouchers, Ingredients/Recipes/Suppliers/Purchase Options, Costing, Inventory, and Reports.
• API access is Business-scoped and currently requires a plan whose effective API Access entitlement is enabled; the standard Pro and Enterprise plans include it.
• The public API is intended for server-to-server integrations, dashboards, automations, and alternative interfaces.
• Native local capabilities such as printer discovery, CDS local discovery/pairing, KDS/POS installation credentials, provider secrets, and platform-admin functions are intentionally not public API operations.

When to use this

• Use the API when another trusted server needs structured MiniTill data/actions and a built-in integration does not already solve the requirement.

Step-by-step

1. Confirm API Access is included for the Business.
2. Create an API key with only required scopes.
3. Download/read the API Reference or OpenAPI/Postman assets.
4. Authenticate with X-Api-Key.
5. Implement idempotency for retry-sensitive mutations.
6. Respect per-key minute limits and Business daily limits.
7. Handle RFC 7807 error responses explicitly.

Common mistakes

• Do not embed a secret API key in publicly downloadable browser JavaScript or a consumer mobile app.
• Do not build against internal routes omitted from the public contract.
• Do not grant write scopes to a read-only reporting integration.

Troubleshooting

• If API Access is disabled, upgrading or an entitlement override is required before creating active keys.
• If an endpoint is not in the public API docs/OpenAPI registry, treat it as unsupported for third-party use.