menu_items
The menu_items
API retrieves a list of all of the menu items in the database, together with the beverages to which they are paired for recommendation and the menu sections on which they appear.
Parameters
- api_key (string) Required - The API key for the account
- last_updated_at (datetime) Optional - If this parameter is supplied, only menu items whose last edited date is after the supplied date and time will be returned. The parameter should be formatted as "YYYY-MM-DD HH:MM:SS" and will be interpreted as a UTC date and time value.
Response
The menu_items
API returns a JSON array of menu items. Each member of the array includes these attributes:
- id - Unique identifier.
- updated_at - The date that this menu item was last edited.
- created_at - The date that this menu item was created.
- sections - Array of sections where the menu item should be displayed. Each section object includes a menu section id and the ordinal of this menu_item within the section.
- paired_beverage_sku_ids - Array of beverage SKU objects to be paired with this menu item. Each object has an id that may refer to a SKU retrieved by the wine_list API, the beer_list API, or the spirit_list API as well as a visible_on_menu property that determines whether to display this beverage when showing the details of the menu item.
- paired_product_sku_ids - Array of product SKU objects to be paired with this menu item. Each object has an id that refers to a SKU retrieved by the product_list_groups API, as well as a visible_on_menu property that determines whether to display this product when showing the details of the menu item.
- name - Short name for the menu item.
- summary - Longer name for the menu item.
- description - Long description of the menu item.
- price - Price in dollars of the meal. May be null.
- status - The current status of the meal. A value of
0
indicates an active meal. A value of1
indicates a deleted meal. - is_recommended - Set to
true
if this menu item should be displayed with a "recommended" indicator andfalse
otherwise. - tags - Array of values of tags for the SKU. To convert these values to names, look them up using the profile API.
- pairing_types - Array of beverage type ids indicating which beverage types this menu item has pairings for.
Sample Request
https://dashboard.onpremisewine.com/menu_items.json?api_key=ABCDEF123456
Sample Response
{
"menu_items": [
{
"id": 846,
"updated_at": "2012-11-19T11:34:17-08:00",
"created_at": "2012-11-19T11:34:17-08:00",
"sections": [
{
"menu_section_id": 191,
"ordinal": 0
}
],
"paired_beverage_sku_ids": [],
"paired_product_sku_ids": [
{
"id": 18285,
"visible_on_menu": true
}
],
"name": "Caprese Salad",
"summary": null,
"description": "Mixed greens with vine ripened tomatoes, fresh mozzarella, balsamic reduction, basil , extra virgin olive oil.",
"price": null,
"status": 0,
"is_recommended": false,
"tags": [],
"pairing_types": []
},
{
"id": 853,
"updated_at": "2012-11-19T11:34:17-08:00",
"created_at": "2012-11-19T11:34:17-08:00",
"sections": [
{
"menu_section_id": 189,
"ordinal": 7
}
],
"paired_beverage_sku_ids": [
{
"beverage_sku_id": 16078,
"visible_on_menu": true
},
{
"beverage_sku_id": 16865,
"visible_on_menu": true
}
],
"paired_product_sku_ids": [],
"name": "Blackened Salmon Filet",
"summary": null,
"description": "With chardonnay-cream sauce over fettuccine",
"price": null,
"status": 0,
"is_recommended": false,
"tags": [],
"pairing_types": [1]
}
]
}