The OpenMenu Format Specification

The current OpenMenu Format will be contained here and listed below. The current xml/json structures are listed below and details of each property can be found on the OpenMenu Format Details page.

Sample XML structure

<omf uuid="" created_date="" accuracy="" private="">
  <openmenu>
    <version></version>
    <crosswalks>
      <crosswalk>
        <crosswalk_id></crosswalk_id>
        <crosswalk_company></crosswalk_company>
        <crosswalk_url></crosswalk_url>
      </crosswalk>
    </crosswalks>
  </openmenu>

  <restaurant_info>
    <restaurant_name></restaurant_name>
    <brief_description></brief_description>
    <full_description></full_description>
    <business_type></business_type>
    <location_id></location_id>
    <mobile></mobile>
    <logo_urls>
      <logo_url width="" height="" type="" media=""></logo_url>
    </logo_urls>
    <address_1></address_1>
    <address_2></address_2>
    <city_town></city_town>
    <region_area name="" designation=""></region_area>
    <state_province></state_province>
    <postal_code></postal_code>
    <country></country>
    <phone></phone>
    <fax></fax>
    <longitude></longitude>
    <latitude></latitude>
    <utc_offset></utc_offset>
    <website_url></website_url>
    <omf_file_url></omf_file_url>
    <environment>
      <seating_qty></seating_qty>
      <smoking_allowed></smoking_allowed>
      <max_group_size></max_group_size>
      <pets_allowed></pets_allowed>
      <age_level_preference></age_level_preference>
      <dress_code></dress_code>
      <cuisine_type_primary></cuisine_type_primary>
      <cuisine_type_secondary></cuisine_type_secondary>
      <takeout_available></takeout_available>
      <delivery_available radius="" fee=""></delivery_available>
      <catering_available></catering_available>
      <wheelchair_accessible></wheelchair_accessible>
      <reservations></reservations>
      <alcohol_type></alcohol_type>
      <music_type></music_type>
      <parking street_free="" street_metered="" private_lot="" garage="" valet=""></parking>
      <seating_locations>
        <seating_location></seating_location>
      </seating_locations>
      <accepted_currencies>
        <accepted_currency></accepted_currency>
      </accepted_currencies>
      <online_reservations>
        <online_reservation type="">
          <online_reservation_name></online_reservation_name>
          <online_reservation_url></online_reservation_url>
        </online_reservation>
      </online_reservations>
      <online_ordering>
        <online_order type="">
          <online_order_name></online_order_name>
          <online_order_url></online_order_url>
        </online_order>
      </online_ordering>
      <operating_days>
        <operating_day>
          <day_of_week></day_of_week>
          <open_time></open_time>
          <close_time></close_time>
        </operating_day>
      </operating_days>
    </environment>
    <parent_company>
      <parent_company_name></parent_company_name>
      <parent_company_website></parent_company_website>
      <address_1></address_1>
      <address_2></address_2>
      <city_town></city_town>
      <state_province></state_province>
      <postal_code></postal_code>
      <country></country>
      <phone></phone>
      <fax></fax>
    </parent_company>
    <contacts>
      <contact type="">
        <first_name></first_name>
        <last_name></last_name>
        <email></email>
      </contact>
    </contacts>
  </restaurant_info>

  <menus>
    <menu name="" uid="" currency_symbol="" language="" disabled="">
      <menu_description></menu_description>
      <menu_note></menu_note>
      <menu_duration>
        <menu_duration_name></menu_duration_name>
        <menu_duration_time_start></menu_duration_time_start>
        <menu_duration_time_end></menu_duration_time_end>
      </menu_duration>
      <menu_groups>
        <menu_group name="" uid="" disabled="">
      	  <menu_group_description></menu_group_description>
          <menu_group_note></menu_group_note>
          <menu_group_options>
            <menu_group_option name="" min_selected="" max_selected="">
               <menu_group_option_information></menu_group_option_information>
               <menu_group_option_item>
                 <menu_group_option_name></menu_group_option_name>
                 <menu_group_option_additional_cost></menu_group_option_additional_cost>
               </menu_group_option_item>
            </menu_group_option>
          </menu_group_options>
          <menu_items>
            <menu_item uid="" disabled="" special="" vegetarian="" vegan="" kosher="" halal="" gluten_free="">
              <menu_item_name></menu_item_name>
              <menu_item_description></menu_item_description>
              <menu_item_image_urls>
                <menu_item_image_url width="" height="" type="" media=""></menu_item_image_url>
              </menu_item_image_urls>
              <menu_item_price></menu_item_price>
              <menu_item_calories></menu_item_calories>
              <menu_item_heat_index></menu_item_heat_index>
              <menu_item_allergy_information allergens=""></menu_item_allergy_information>
              <menu_item_sizes>
                <menu_item_size>
                  <menu_item_size_name></menu_item_size_name>
                  <menu_item_size_description></menu_item_size_description>
                  <menu_item_size_price></menu_item_size_price>
                  <menu_item_size_calories></menu_item_size_calories>
                </menu_item_size>
              </menu_item_sizes>
              <menu_item_options>
                <menu_item_option name="" min_selected="" max_selected="">
                  <menu_item_option_information></menu_item_option_information>
                  <menu_item_option_item>
                    <menu_item_option_name></menu_item_option_name>
                    <menu_item_option_additional_cost></menu_item_option_additional_cost>
                  </menu_item_option_item>
                </menu_item_option>
              </menu_item_options>
              <menu_item_tags>
                <menu_item_tag></menu_item_tag>
              </menu_item_tags>
            </menu_item>
          </menu_items>
        </menu_group>
      </menu_groups>
    </menu>
  </menus>
</omf>

(click here for a live sample in the standard format)

Sample JSON structure

Beta: The default standard is XML but we're testing a JSON format.

{
  "omf_uuid":"",
  "omf_accuracy":"",
  "privacy":"",
  "omf_version":"",
  "omf_updated_timestamp":"",
  "restaurant_info":{
    "restaurant_name":"",
    "brief_description":"",
    "full_description":"",
    "location_id":"",
    "mobile":"",
    "address_1":"",
    "address_2":"",
    "city_town":"",
    "state_province":"",
    "postal_code":"",
    "country":"",
    "phone":"",
    "fax":"",
    "longitude":"",
    "latitude":"",
    "business_type":"",
    "utc_offset":"",
    "website_url":"",
    "omf_file_url":""
  },
  "environment_info":{
    "cuisine_type_primary":"",
    "cuisine_type_secondary":"",
    "smoking_allowed":"",
    "takeout_available":"",
    "seating_qty":"",
    "max_group_size":"",
    "pets_allowed":"",
    "wheelchair_accessible":"",
    "age_level_preference":"",
    "dress_code":"",
    "delivery_available":"",
    "delivery_radius":"",
    "delivery_fee":"",
    "catering_available":"",
    "reservations":"",
    "alcohol_type":"",
    "music_type":""
  },
  "parent_company":{
    "parent_company_name":"",
    "parent_company_website":"",
    "address_1":"",
    "address_2":"",
    "city_town":"",
    "state_province":"",
    "postal_code":"",
    "country":"",
    "phone":"",
    "fax":""
  },
  "operating_days":{
    "mon_open_time":"",
    "mon_close_time":"",
    "tue_open_time":"",
    "tue_close_time":"",
    "wed_open_time":"",
    "wed_close_time":"",
    "thu_open_time":"",
    "thu_close_time":"",
    "fri_open_time":"",
    "fri_close_time":"",
    "sat_open_time":"",
    "sat_close_time":"",
    "sun_open_time":"",
    "sun_close_time":""
  },
  "seating_locations":[
    {
      "seating_location":""
    },
  ],
  "logo_urls":[
    {
      "logo_url":"", 
      "width":"", 
      "height":"",
      "image_type":"",
      "image_media":""
    },
  ],
  "contacts":[
    {
      "first_name":"",
      "last_name":"",
      "email":"",
      "contact_type":""
    },
  ],
  "accepted_currencies":[
    {
      "accepted_currency":""
    },
  ],
  "online_reservations":[
    {
      "online_reservation_type":"", 
      "online_reservation_name":"", 
      "online_reservation_url":""
    },
  ],
  "online_ordering":[
    {
      "online_order_type":"", 
      "online_order_name":"", 
      "online_order_url":""
    },
  ],
  "parking":{
    "street_free":"",
    "street_metered":"",
    "private_lot":"",
    "garage":"",
    "valet":""
  },
  "crosswalks":[
    {
      "crosswalk_id":"", 
      "crosswalk_company":"", 
      "crosswalk_url":""
    },
  ],
  "menus":[
    {
      "menu_name":"",
      "menu_description":"",
      "menu_note":"",
      "currency_symbol":"",
      "language":"",
      "disabled":"",
      "menu_uid":"",
      "menu_duration_name":"",
      "menu_duration_time_start":"",
      "menu_duration_time_end":"",
      "menu_groups":[
        {
          "group_name":"",
          "group_description":"",
          "group_note":"",
          "group_uid":"",
          "disabled":"",
          "menu_group_options":[
             {
               "group_options_name": "",
               "menu_group_option_information": "",
               "menu_group_option_min_selected": "",
               "menu_group_option_max_selected": "",
               "option_items": [
                 {
                   "menu_group_option_name": "",
                   "menu_group_option_additional_cost": ""
                 },
               ]
             },
          ],
          "menu_items":[
            {
              "menu_item_name":"",
              "menu_item_description":"",
              "menu_item_price":"",
              "menu_item_calories":"",
              "menu_item_heat_index":"",
              "menu_item_allergy_information":"",
              "menu_item_allergy_information_allergens":"",
              "item_uid":"",
              "disabled":"",
              "special":"",
              "vegetarian":"",
              "vegan":"",
              "kosher":"",
              "halal":"",
              "gluten_free":"",
              "menu_item_options":[
                {
                  "item_options_name": "",
                  "menu_item_option_information": "",
                  "menu_item_option_min_selected": "",
                  "menu_item_option_max_selected": "",
                  "option_items": [
                    {
                      "menu_item_option_name": "",
                      "menu_item_option_additional_cost": ""
                    },
                  ]
                },
              ],
              "menu_item_sizes":[
                {
                  "menu_item_size_name": "",
                  "menu_item_size_description": "",
                  "menu_item_size_price": "",
                  "menu_item_size_calories": ""
                },
              ],
              "menu_item_tags":[
                {
                  "menu_item_tag": ""
                },
              ],
              "menu_item_images":[
                {
                  "image_url":"",
                  "width":"",
                  "height":"",
                  "image_media_id":"",
                  "image_type_id":"",
                  "image_type":"",
                  "image_media":""
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

(click here for a live sample in JSON format)

Tools

OpenMenu Validator Checking OpenMenu's for compliance to the latest and greatest OpenMenu Format. OpenMenu Validator lists issues that would prevent getting the most out of an OpenMenu.

Code Samples Code samples to get you started using the OpenMenu Platform. Our library will continue to grow to provide developers with a jump start into OpenMenu development.

Current Stable Version - 1.6.1

specification details | changelog

Working Draft - v1.6.2

Contributors

OpenMenu

Downloads

Empty OpenMenu File

Contact Us

Have a question or comment? Contact us.