API Overview
Endpoints for tills, locations, orders (v1/v2 & live), reports, catalog, consumers, keys, jobs, and health.
Key areas
- Server Health: service readiness probes
- Accounting: accounting-oriented till creation
- Catalog: categories, products, modifiers, taxes, payments
- Consumers: create, fetch, and list consumers
- Jobs: schedule or create back-office jobs
- Keys: API key management for integrations
- Locations: CRUD and import utilities for locations
- Orders v1/v2: fetch single or multiple orders by version
- Orders Live: live order stream endpoints
- Reports: list and fetch various reports
- Tills: create, fetch, reprocess, replace, and location-wide operations
Base URL
The base URL varies by environment. Contact your system administrator for the appropriate endpoint.
Authentication
All endpoints require JWT authentication. Include your access token in the Authorization header:
Authorization: Bearer <your-access-token>Explore Endpoints
Use the left sidebar to browse all available operations.