Restaurant
Menu, customer, order, and labor entities normalized across restaurant platforms — Square, Toast, Clover, and Lightspeed K-Series.
Menu, customer, order, and labor entities normalized across restaurant platforms — Square, Toast, Clover, and Lightspeed K-Series.
Systems
| System | Auth | Rate limit |
|---|---|---|
| Square | OAuth 2.0 | 5 req / s |
| Toast | API token | 5 req / s |
| Clover (Asia Pacific) | API token | 5 req / 6s |
| Clover (US) | API token | 5 req / 6s |
| Lightspeed K-Series | OAuth 2.0 | 100 req / 60s |
Entities
Category
Portable restaurant category contract. externalId and name are the core portable fields. Parent hierarchy is k…
Customer
Portable restaurant customer contract. firstName and lastName are optional for read portability, but Square an…
Employee
Portable restaurant labor employee contract with stable identity and core staffing fields.…
Job
Portable restaurant job / role contract.…
Modifier group
Portable restaurant modifier-group contract for menu customization groups.…
Order
Portable restaurant order contract with normalized identity, timing, party references, totals, and line items.…
Product
Portable restaurant product contract. externalId and name are the stable base fields. categoryExternalId is es…
Shift
Portable restaurant labor shift / timecard contract.…
Time entry
Portable restaurant labor time-entry / punch-clock contract.…
Product · product
Portable POS product contract. externalId and name are the stable core fields; description, price, taxable, currencyCode, and categoryExternalId become important for some write targets such as Lightspeed R-Series, Square, and Clover.
Category · category
Portable restaurant category contract. externalId and name are the core portable fields. Parent hierarchy is kept as parentExternalId when sources provide it.