Menu
Ordering Stack Menu API. Manage menu for restaurants, menu nodes, menu items, priceslists, combo meals, etc.
177 subscribers
21 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Menu endpoints
| Method | Endpoint | Description |
|---|---|---|
| locks | ||
| DELETE |
deleteLock /menu-api/api/manage-locks/{lock} |
Remove lock with provided ID. |
| GET |
getLock /menu-api/api/manage-locks/{lock} |
Get lock definition by id |
| POST |
postLock /menu-api/api/manage-locks |
Create new lock. Its ID must be new end unique. Overriding existing locks is not allowed. To alter a lock simply delete old one and create new. |
| GET |
getLocks /menu-api/api/manage-locks |
Get paginated list of Locks. This endpoint is compatible with React AdminOnRest framework to provide DataSource. |
| GET |
locks /menu-api/api/locks/{instance} |
Get currently set locks for instance (i.e. venue). Returns all locks with matching instance and global locks (without any instance assigned) |
| menu definition | ||
| PUT |
putMenu /menu-api/api/menu-definitions/{menu} |
Update menu definition. ID in input document is overridden by the one from path. This method does upsert in database. |
| GET |
getMenu /menu-api/api/menu-definitions/{menu} |
Get menu definition by ID. |
| DELETE |
deleteMenu /menu-api/api/menu-definitions/{menu} |
Delete menu definition by ID. |
| POST |
postMenu /menu-api/api/menu-definitions |
Create new menu definition. If ID is not provided it will be generated. Otherwise this method is similar to PUT method and does upsert in database. |
| GET |
getDefinitions /menu-api/api/menu-definitions |
Get paginated list of Menu definitions (menu sets assigned to venues). This endpoint is compatible with React AdminOnRest framework to provide DataSource. |
| items | ||
| GET |
getList /menu-api/api/items |
Get paginated list of MenuItems. This endpoint is compatible with React AdminOnRest framework to provide DataSource. |
| POST |
previewProduct /menu-api/api/preview |
Preview product. Resolves references and queries to provide full product config. Nothing more (i.e. pricelists, prices and locks) is calculated here so that no sub-products are… |
| PUT |
putItem /menu-api/api/items/{item} |
Update menu item. ID from path overrides the one provided in input object. Method does upsert in database. |
| GET |
menuItems /menu-api/api/menu/{menu}/products |
Get multiple products definition. Returns definitions of products by their IDs. All references are evaluated. |
| GET |
getItem /menu-api/api/items/{item} |
Retrieve menu item by ID from database. |
| POST |
postItem /menu-api/api/items |
Create new menu item. If ID is not provided it will be generated. Otherwise this method is similar to PUT method and does upsert in database. |
| DELETE |
deleteItem /menu-api/api/items/{item} |
Deletes menu item by id. Be carefull when deleting items as they may be referenced by References in other items. |
| menu | ||
| GET |
menu /menu-api/api/menu/{menu} |
Get menu definition. Returns whole menu with evaluated references and queries. Also returns currently defined locks for instance. |
| GET |
menuItem /menu-api/api/menu/{menu}/{product} |
Get single product definition. Returns product definition by its ID. All references are evaluated. |
| POST |
validateProduct /menu-api/api/menu/{menu}/validate |
Validate product. Validates product with provided configuration of options and sub-products against product definition, current locks, etc. It also generates ProductDescription… |
| GET |
search /menu-api/api/menu/{menu}/search |
Search for products by partial string (suggest). Returns all products which id, name or description literals contains provided string. It tries to determine locale by… |
Menu pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
