OpenMenu API - menu

Locate information on menu items and information on unique ids (specifically on menus, menu groups or menu items).

Call

http://openmenu.com/api/v1/menu?key=[API_KEY] + parameters

Parameters

  • key

    developers key for access to the API format: api key required

  • output

    format of the output response format: xml | json (default: xml) not required

  • offset

    offset of results to get (paging) format: integer (max 100) (default: 0) not required

  • id

    id of the openmenu, menu, menu group or menu item attached to a specific id format: UUID v4 required if item not passed

  • item

    full or partial name of a menu item / menu description to search on format: string required if id ot passed

  • city

    full city to limit update results to (item search) format: string not required

  • state

    state or province to limit update results to (item search) format: 2 characters (two-digit code) not required

  • postal_code

    postal_code to limit update results to (item search) format: string not required

  • country

    country to limit update results to (item search) format: ISO 3166-1 alpha-2 not required

  • min_price

    minimum price for a menu item to be returned (item search) format: numeric not required

  • max_price

    maximum price for a menu item to be returned (item search) format: numeric not required

  • compact

    sets that results are compacted to group by menu items (item search) format: empty parameter (true if present) not required

Return Values

  • restaurant_name

    name of the restaurant format: 2 - 255 characters

  • business_type

    classification for the restaurants business type format: Franchisee | Corporate | Independent

  • address_1

    primary address of the restaurant (item search) format: 2 - 120 characters

  • city_town

    city or town of the restaurant (item search) format: 2 - 50 characters

  • state_province

    state or Province of the restaurant (item search) format: 2 characters (two-digit code)

  • country

    country of the restaurant (item search) format: 2 characters (ISO 3166-1 alpha-2)

  • latitude

    latitude for the restaurant (item search) format: 0 - 10 characters: (-)nn.nnnnnn

  • longitude

    longitude for the restaurant (item search) format: 0 - 11 characters: (-)nnn.nnnnnn

  • openmenu_id

    the OpenMenu ID for the restaurant format: UUID v4

  • accuracy

    the Accuracy value for the restaurant (item search) format: numeric 1-9

  • registrar

    registrar in control of the restaurant format: string

  • omf_file_url

    OpenMenu URL for the restaurant format: 11 - 120 characters starting with http://

  • type

    what is the type of id (id search) format: openmenu | menu | group | item

  • name

    name of the item attached to the id (id search) format: string

  • menu_item_uid

    unique id of the a menu item (item search) format: UUID v4

  • menu_item_name

    name of the a menu item (item search) format: 2 - 75 characters

  • menu_item_price

    price for the a menu item (item search) format: 1 - 7 characters: nnnn.nn

  • menu_item_description

    description of the a menu item (item search) format: 0 - 450 characters

Return Status Codes

  • 200

    successful call

  • 204

    call resulted in an empty resultset

  • 400

    api key is missing

  • 417

    missing required parameters

  • 401

    incorrect API key

Sample Response

Sample Response - id=


Sample Response - item=

Notes

  • either item or id must be passed
  • precedence for call is id -> item
  • if min_price or max_price is used, menu items without a defined price will be returned