Specification - v1.1.5

Open Menu™ Format files should be of the extension .xml

The current Open Menu™ Format will be contained here and listed below. The current xml structure and details of each property is listed below - each property lists the allowable information for that property.

Check out the Working Draft of the next version of the Open Menu Format

Sample XML structure

<omf created_date="">
  <omf_version>
    <version>1.1.5</version>
    <editor>Open Menu Creator v1 http://openmenu.com/creator</editor>
    <general_info></general_info>
  </omf_version>

  <restaurant_info>
    <restaurant_name></restaurant_name>
    <brief_description></brief_description>
    <full_description></full_description>
    <location_id></location_id>
    <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>
    <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>
      <seating_locations>
        <seating_location></seating_location>
      </seating_locations>
      <accepted_currencies>
        <accepted_currency></accepted_currency>
      </accepted_currencies>
      <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="" disabled="">
      <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_options>
            <menu_group_option name="">
               <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="">
              <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_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="">
                  <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>

Details of the specification

omf

Attributes

created_date
date the OMF file was created format: yyyy-mm-dd (ISO 8601)

omf_version

Tags

version
The version of the OMF spec that this file adheres to format: decimal with a . (period) seperator
editor
Name of the editor used to create the OMF file format: 0 - 100 characters
general_info
Additional information about the spec/version
requirment: not required format: 0 - 255 characters

restaurant_info

Tags

restaurant_name
Name of the restaurant format: 2 - 255 characters
brief_description
Brief description of the restaurant format: 0 - 255 characters (no HTML allowed)
full_description
Full description of the restaurant format: 0 - 2000 characters (no HTML allowed)
location_id
ID of the restaurant if its a chain or has a parent company
requirment: not required format: 0 - 25 characters
address_1
Primary address of the restaurant format: 2 - 120 characters
address_2
Secondary address of the restaurant
requirment: not required format: 0 - 120 characters
city_town
City or town of the restaurant format: 2 - 50 characters
region_area
Region or area as defined within the city or town. This tag can be nested to create nested sections
requirment: not required format: empty (attributes only)

Attributes
- name
  Name of the region or section format: 2 - 50 characters
- designation
  What is the designation for this section or area (ex. district, neighborhood, burough) format: 2 - 50 characters
state_province
State or Province of the restaurant
requirment: not required format: 2 characters (two-digit code)
postal_code
Postal code of the restaurant
requirment: not required format: 0 - 30 characters
country
Country of the restaurant format: 2 characters (ISO 3166-1 alpha-2)
phone
Phone of the restaurant
requirment: not required format: Numeric with punctuations (allowed: #*()-/_) 7-40 characters
fax
Fax of the restaurant
requirment: not required format: Numeric with punctuations (allowed: #*()-/_) 7-40 characters
longitude
Longitude of the restaurant. Used for easily locating the restaurant on GPS or other mapping services
requirment: not required format: 0 - 11 characters: (-)nnn.nnnnnn
latitude
Latitude of the restaurant. Used for easily locating the restaurant on GPS or other mapping services
requirment: not required format: 0 - 10 characters: (-)nn.nnnnnn
website_url
URL to the restaurants website
requirment: not required format: 0 - 120 characters starting with http://
omf_file_url
URL where the OMF file is stored or can be accessed from format: 0 - 120 characters starting with http://

logo_urls

Tags

logo_url
URL a logo file
requirment: Must include a 32px x 32px (thumbnail) and 200px x 200px (full) version for web format: URL starting with http:// in GIF|JPG|PNG format

Attributes
- width
  Width of the image format: numeric
- height
  Height of the image format: numeric
- type
  Intended use for the logo format: select from full | thumbnail
- media
  What media is the logo meant to be displayed for format: select from mobile | print | web

environment

seating_qty
How many people can be seated at the restaurant
requirment: not required format: numeric
smoking_allowed
Is smoking allowed at the restaurant
requirment: not required format: select from 1|0 (1 = true)
max_group_size
What the maximum group a restaurant can accommodate
requirment: not required format: numeric
pets_allowed
Are pets allowed at the restaurant
requirment: not required format: select from 1|0 (1 = true)
age_level_preference
Defines an preference for the restaurant
requirment: not required format: (+/-)nnn
dress_code
What is the dress code for the restaurant
requirment: not required format: select from none|casual|business-casual|business
cuisine_type_primary
The primary cuisine type for the restaurant. Select from the approved list as to the type of restaurant. Option to add your own type which will be evaluated for inclusion in the list.
requirment: A primary cuisine type must be entered format: recommended to select from American | Afghan | African | Argentinean | Asian/Oriental | Bakery | Barbeque | Brazilian | Brew/Pubs/Microbrewery | Cajun/Creole | California | Caribbean | Chinese | Coffee House | Continental | Cuban | Desserts | Diner | Ethiopian | Family/Homestyle | French/French Bistro | Fusion | German | Greek | Hamburger | Hawaiian | Hot Dog | Indian | International | Irish | Italian | Japanese | Latin | Kosher | Malaysian | Mediterranean | Mexican | Moroccan | Pacific Rim | Pizza | Portuguese | Russian | Sandwiches | Seafood | Soup | Southwest | Southern Cuisine | Spanish | Steakhouse | Sunday Brunch | Sushi | Tapas | Thai | Vegetarian | Vietnamese
cuisine_type_secondary
A secondary cuisine type for the restaurant may be designated. Select from the approved list as to the type of restaurant. Option to add your own type which will be evaluated for inclusion in the list.
note: Restaurants should not rely on this value as it may not be implemented in some systems. format: recommended to select from American | Afghan | African | Argentinean | Asian/Oriental | Bakery | Barbeque | Brazilian | Brew/Pubs/Microbrewery | Cajun/Creole | California | Caribbean | Chinese | Coffee House | Continental | Cuban | Desserts | Diner | Ethiopian | Family/Homestyle | French/French Bistro | Fusion | German | Greek | Hamburger | Hawaiian | Hot Dog | Indian | International | Irish | Italian | Japanese | Latin | Kosher | Malaysian | Mediterranean | Mexican | Moroccan | Pacific Rim | Pizza | Portuguese | Russian | Sandwiches | Seafood | Soup | Southwest | Southern Cuisine | Spanish | Steakhouse | Sunday Brunch | Sushi | Tapas | Thai | Vegetarian | Vietnamese
takeout_available
Determines if the restaurant has takeout available
requirment: not required format: select from 1|0 (1 = true)

seating_locations

seating_location
Can people be seated outside, inside or both. Option to add your own location which will be evaluated for inclusion in the list format: recommended to select from indoor | outdoor | rooftop | poolside | deck | cellar | pier | veranda | porch | beach | terrace | patio | sidewalk

accepted_currencies

accepted_currency
Defines the currency symbol for menu item prices (defaults to USD) format: 3 characters (ISO 4217)

operating_days

operating_day
Sets the days and times that the restaurant is open format: structure as defined below

Tags
- day_of_week
  Sets the day of the week the restaurant is open format: 1 digit (ISO 8601: mon:1, tue:2, wed:3, thu:4, fri:5, sat:6, sun:7)
- open_time
  Sets the opening time format: hh:mm (ISO 8601 - 24 hour time)
- close_time
  Sets the closing time format: hh:mm (ISO 8601 - 24 hour time)

contacts

contact
Sets the various contacts for the restaurant requirment: one contact is required format: structure as defined below

Tags
- first_name
  First name of the contact format: 2 - 25 characters
- last_name
  Last name of the contact
  requirment: not required format: 2 - 25 characters
- email
  Email of the contact
  requirment: not required format: 7 - 120 characters
Attribute
- type
  Type of contact. Option to add your own type which will be evaluated for inclusion in the list. format: recommended to select from om_creator | primary | chef (2 - 50 characters)

parent_company

parent_company_name
Name of the parent company
requirment: not required format: 0 - 255 characters
parent_company_website
Parent company website
requirment: not required format: 0 - 120 characters starting with http://
address_1
Primary address of the parent company
requirment: not required format: 2 - 120 characters
address_2
Secondary address of the parent company
requirment: not required format: 0 - 120 characters
city_town
City or town of the parent company
requirment: not required format: 2 - 50 characters
state_province
State or Province of the parent company
requirment: not required format: 2 characters (two-digit code)
postal_code
Postal code of the parent company
requirment: not required format: 0 - 30 characters
country
Country of the parent company
requirment: not required format: 2 characters (ISO 3166-1 alpha-2)
phone
Phone of the parent company
requirment: not required format: Numeric with punctuations (allowed: #*()-/_) 7-40 characters
fax
Fax of the parent company
requirment: not required format: Numeric with punctuations (allowed: #*()-/_) 7-40 characters

menus (can contain multiple menus)

Tags

menu_duration
What time of day is this menu valid for format: structure as defined below

Tags
- menu_duration_name
  Sets name for the duration this menu is valid for. Option to add your own duration name which will be evaluated for inclusion in the list. format: recommended to select from breakfast | brunch | lunch | breakfast-lunch | dinner | lunch-dinner | late-night | all
- menu_duration_time_start
  Start time when this menu is valid for format: hh:mm (ISO 8601 - 24 hour time)
- menu_duration_time_end
  End time when this menu is valid for format: hh:mm (ISO 8601 - 24 hour time)

Attributes

name
Name for this menu format: 0 - 50 characters
uid
Unique identifier for this menu format: 36 characters (uuid)
currency_symbol
Will be used to determine the currency symbol to show next to prices (defaults to USD) format: 3 characters (ISO 4217)
disabled
Sets that this menu is disabled format: set to disabled (disabled="disabled")

menu_groups

menu_group

Attributes

name
Name for this menu group format: 0 - 50 characters
uid
Unique identifier for this menu group format: 36 characters (uuid)
disabled
Sets that this menu group is disabled format: set to disabled (disabled="disabled")

menu_group_options

Tags

menu_group_option
Defines option(s) for all menu items contained within this group format: structure as defined below

Attributes
- name
  Name for this menu group's options format: 0 - 50 characters
Tags
- menu_group_option_item
  Details of an item for this option group format: structure as defined below
  
  Tags
  - menu_group_option_name
    Name of this option format: 2 - 50 characters
  - menu_group_option_additional_cost
    Set any additional costs this option will add a menu item
    requirment: not required format: 1 - 7 characters: nnnn.nn (numeric only, period separator for decimals)

menu_items

Tags

menu_item_name
Name of the menu item format: 2 - 75 characters (no HTML allowed)
menu_item_description
Description for the menu item
requirment: not required format: 0 - 450 characters (no HTML allowed)
menu_item_price
Price for the menu item (no currency symbol) format: 1 - 7 characters: nnnn.nn (numeric only, period separator for decimals)
menu_item_calories
How many calories for this item
requirment: not required format: numeric
menu_item_allergy_information
Any information about allergy warnings for this item
requirment: not required format: 0 - 450 characters (no HTML allowed)

Attributes
- allergens
  Specific names of allergens. Option to add your own allergens which will be evaluated for inclusion in the list. (multiple selections will be comma seperated) format: recommended to select from Egg | Fish | Dairy | Peanut | Shellfish | Soy |Tree Nut | Wheat | Gluten
menu_item_image_urls
Urls to images to be used when displaying this menu item format: structure as defined below

Tags
- menu_item_image_url
  URL to an image file for the menu item
  requirment: not required. If included must include a 32px x 32px (thumbnail) and 200px x 200px (full) version for web format: URL starting with http:// in GIF|JPG|PNG format
  
  Attributes
  - width
    Width of the image format: numeric
  - height
    Height of the image format: numeric
  - type
    Intended use for the menu item image format: select from full | thumbnail | zoom
  - media
    What media is the logo meant to be displayed for format: select from mobile | print | web

Attributes

uid
Unique identifier for this menu item format: 36 characters (uuid)
disabled
Sets that this menu item is disabled format: set to disabled (disabled="disabled")
special
Sets that this menu item is a special format: set to special (special="special")
vegetarian
Sets that this menu item is vegetarian format: set to vegetarian (vegetarian="vegetarian")
vegan
Sets that this menu item is vegan format: set to vegan (vegan="vegan")
kosher
Sets that this menu item is kosher format: set to kosher (kosher="kosher")
halal
Sets that this menu item is halal format: set to halal (halal="halal")

menu_item_sizes (optional)

menu_item_size_name
Name for an alternate size for a menu item (small, medium, large, cup, bowl) format: 0 - 25 characters
menu_item_size_description
Description of the alternate size
requirment: not required format: 0 - 120 characters
menu_item_size_price
Price for the menu item (no currency symbol) format: 1 - 7 characters: nnnn.nn (numeric only, period separator for decimals)
menu_item_size_calories
How many calories for this item
requirment: not required format: numeric

menu_item_options (optional)

Tags

menu_item_option
Defines option(s) for this menu item format: structure as defined below

Attributes
- name
  Name for this menu item's options format: 0 - 50 characters
Tags
- menu_item_option_item
  Details of an item for this option group format: structure as defined below
  
  Tags
  - menu_item_option_name
    Name of this option format: 2 - 50 characters
  - menu_item_option_additional_cost
    Set any additional costs this option will add a menu item
    requirment: not required format: 1 - 7 characters: nnnn.nn (numeric only, period separator for decimals)

menu_item_tags (optional)

Tags

menu_item_tag
Defines a tag for this menu item format: 0 - 35 characters

Get a blank OMF file

Previous Versions

Online Open Menu™ Creator

Use the Online Open Menu™ Creator to quickly and easily convert your menu to an Open Menu™ Format menu.

Create Your Menu Now

Projects

Open Menu™ Search

Locate a restaurant by searching for a menu items you're interested in. For example, locate a restaurant in your location which is serving chocolate cake for desert.

Open Menu Search