Get started using Revel with the On-Brand Menu API.
Create a Revel Source
Revel support is currently in private beta, contact email@example.com and we’ll be in touch.
Revel categories and sub-categories will be returned as menu groups via the On-Brand Menu API. To match the behavior of the Revel POS, categories will be flattened with their sub-categories when the category and sub-category share the same name.
For example, a “Breakfast” category with a “Breakfast” sub-category will only return a single “Breakfast” group with it’s products from the On-Brand Menu API.
Revel products will be returned as menu items via the On-Brand Menu API.
Revel modifiers will be returned as sub-items from the On-Brand Menu API. Sub-items are items that do not belong to a group but are instead associated with another menu item.
Revel does not natively support calories on products but you can use the alternative lookup field to set calorie data.
The On-Brand Menu API looks for an alternative lookup value with the syntax
calories:**number**. For example, to set the calories of an item to 110, add an alternative lookup value of
Calories are only supported on products since Revel does not support alternative lookup on modifiers.
Values in the alternative lookup field of a Revel product are converted to menu item tags in the On-Brand Menu API. You can use these tags to set custom data on an item like
Provide a comma-separated list of values as the “Third Party ID” field to set menu group tags. For example, a third party ID value of
entrees, featured on a category will be converted to two tags (
featured) on the group.
You can use tags on groups to query for specific groups from the On-Brand Menu API.
The Revel product class of a product will be set as the item’s
salesCategory in the On-Brand Menu API.
Only Revel products, modifiers and categories marked as active and available for online will be returned from the On-Brand Menu API.
Sorting Items and Groups
The sort order of items and groups returned by the On-Brand Menu API is controlled via the “Sort” field of Revel categories, product and modifiers.
Set the current inventory of a Revel product to
0 to mark it as out of stock.
The On-Brand Menu API periodically checks for updates to your Revel establishments. Updates are applied whenever you hit “Save” in Revel.
The polling frequency depends on how many menus you want to access via your On-Brand Menu API key. The setup process for a Revel source will determine an appropriate polling frequency to avoid hitting Revel API limits.
- Create an On-Brand Menu API key
- On-Brand Menu API reference
- Check out the Whole Foods Menu sample app