API reference

Core API

General purpose: tenants, outlets, products, menus, checks, orders, payments, webhooks.

View .mdOpenAPI
Base URL
https://core-api.ancon.io
Auth
Access-Token header · get a token
Version
public-v1
Endpoints
101 in 28 groups

Shared behavior such as filtering, rate limits and webhooks is covered in the guides. The original Redoc page is still served by the API.

Resources

AddOnGroups2 endpointsCheckouts6 endpointsChecks16 endpoints · 15 deprecatedCompaniesAll 10 endpoints deprecatedDiscounts2 endpoints · 1 deprecatedFees2 endpointsIngredients2 endpointsIntegrations1 endpointInvoices2 endpointsMenuTrees3 endpointsMetadataTemplates5 endpointsOrders2 endpoints

Orders are the sale history for the outlet, orders are created when a check or checkout is fully paid. The order holds information about what products was sold and how it was paid.

OutletClientGroups5 endpointsOutletClients1 endpointOutlets2 endpoints · 1 deprecated

Outlet is the physical place where the sales happen, it is the restaurant or bar.

ProductGroups5 endpoints · 2 deprecatedProducts13 endpoints · 1 deprecatedSaleSources1 endpointSections3 endpointsSettlementReports1 endpointTables2 endpointsTags1 endpointTaxes2 endpointsTenants2 endpoints

Tenant is a collection of outlets and has entities settings attached to it.

TenantUsers1 endpointTickets2 endpointsUpsellGroups2 endpointsWayOfPayments6 endpointsChecks - Events9 endpoints

Event payload schemas. These are not HTTP endpoints - they document the JSON structure sent via WebSocket when events occur.