Show Menu
Search…
Ctrl+K
ESC
Example searches: “items”, “201”, “200”, “Rich Item”, “href”
Toggle dark mode
API Changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
demo
demo
default
prod
Topics
Introduction
Authentication
Endpoints
Rich Item
Get allergens
GET
Get locales
GET
Update locales
PUT
Get rich items
GET
Get rich item by sku
GET
Create or update rich item
PUT
Delete rich item
DELETE
Update picture
PATCH
Get rich items by SKUs
POST
Get picture specifications
GET
Tax Breakdown
Post proposed order
POST
Shift
Get Shift
GET
Staff
Get All POS Staff
GET
Get All Back Office Staff
GET
Get Single Staff
GET
Reservations for Platforms
Get Business Locations
GET
Platform Profile Details
GET
Create or Update Platform Profile
POST
Activate Integration for Restaurant
POST
Deactivate Integration for Restaurant
POST
Create or Update Reservation
PUT
Callback to Complete Onboarding
POST
Get Sample Order Notification
GET
Get Sample Integration Notification
GET
Get Sample Onboarding Notification
GET
Get Sample Error Notification
GET
Add authentication by XApiKey
PATCH
Add authentication with BasicAuth
PATCH
Add authentication with BearerAuth
PATCH
Add authentication with OAuth2
PATCH
PMS
Get PMS Revenue Centers
GET
Get a PMS provider by ID
GET
Update a PMS provider
PUT
Delete a PMS provider
DELETE
Get PMS providers
GET
Create PMS provider
POST
Items
Get item by Id
GET
Update an item
PUT
Get items by business location
GET
Create item
POST
Reservations
Seating of a reservation
POST
Get businesses data
GET
Seating of a reservation
POST
Register a new webhook endpoint
PUT
Update a webhook endpoint
POST
Get a webhook endpoint
GET
Delete a webhook endpoint
DELETE
Financial
Get Businesses
GET
Get Tax Rates
GET
Get Payment Methods
GET
Get Accounting Groups
GET
Get Financials
GET
Get Daily Financials
GET
Get Receipt by External Reference
GET
Get Aggregated Sales
GET
FinancialV2
Get Sales
GET
Get business day sales
GET
BETA - Get Aborted Orders
GET
Order and Pay
Get Businesses
GET
Get Floorplans
GET
Get tables for floorplan
GET
Get Account Profiles
GET
Get Menu List
GET
Get Single Menu
GET
Get Modifiers
GET
Get Discounts
GET
Create Local Order
POST
Create To Go Order
POST
Get Open Checks
GET
Get Open Check by Table
GET
Get Single Check
GET
Apply a Payment
POST
Print Message
POST
Create a Webhook
PUT
Update a webhook
POST
Retrieve a Webhook
GET
Webhooks
Order and Pay
Notifications order
POST
Notifications payment
POST
Dismiss highlight
Show more
Staff
Staff API