Jump to Content

Guides API Reference

v1.0.0

API Reference

v1.0.0Guides API Reference

POS Export API.

locations
- Get locations.get
- Get location.get
cashDeposits
- Get location cash deposits.get
- Get location cash deposits by id.get
discounts
- Get location discounts.get
- Get location discount by id.get
employees
- Get location employees.get
- Get location employee by id.get
jobPositions
- Get location job positions.get
- Get location job position by id.get
menuItems
- Get location menu items.get
- Get location menu item by id.get
modifierOptions
- Get location modifier options.get
- Get location modifier option by id.get
modifiers
- Get location modifiers.get
- Get location modifier by id.get
orderTypes
- Get location order types.get
- Get location order type by id.get
orders
- Get location orders.get
- Get location order by id.get
paidInOuts
- Get location paid-in-outs.get
- Get location paid-in-out by id.get
paymentOptions
- Get location payment options.get
- Get payment option by id.get
reportCategories
- Get location report categories.get
- Get location report category by id.get
laborReports
- Get location labor reports.get
stations
- Get location stations.get
- Get location station by id.get
surcharges
- Get location surcharges.get
- Get location surcharge by id.get
taxes
- Get location taxes.get
- Get location tax by id.get
teams
timeClockEntries
- Get location time clock entries.get
- Get location time clock entry by id.get

Menu API

Menu

Order API

Order
- Submit orderpost
- Propose orderpost

Menu IDs

get https://example.com/v1/locations/{locationId}/active-menus

Get all currently generated menus for that location

Language

Click Try It! to start a request and see the response here!