Location-to-Menus Map Field Descriptions

To know what menus belong to which locations, there is a mapping from a location to the menus for that location. The mapping consists of a list of individual menu maps. The fields in the menu maps are:

  • id: the numeric ID of the menu
  • name: the unique name of the menu among the menus for the location; used in the REST API
  • orderNum: the order number for this menu in the list of menus; a one (1) based number
  • state: the state of the menu. One of: enableddisabled

Sample Location-To-Menus Map Data

Here is a sample of what the location-to-menus map data would look like.

Single Menu Example

{
  "locationId" : "abc-kitchen",
  "locationToMenus" : [ {
    "id" : 2,
    "name" : "dinner",
    "orderNum" : 1,
    "state" : "enabled"
  } ]
}

Multiple Menu Example

{
  "locationId" : "les-halles",
  "locationToMenus" : [ {
    "id" : 3,
    "name" : "dinner",
    "orderNum" : 1,
    "state" : "enabled"
  },
  {
    "id" : 4,
    "name" : "revolutionary-brunch",
    "orderNum" : 2,
    "state" : "disabled"
  } ]
}

A couple notes to help in understanding the field descriptions below:

  • There are multiple types of entries. Each entry type contains a slightly different set of information and is/should be rendered slightly differently.
  • The list of entries is ordered by the orderNum field. The ordering is important as it defines the order in which to render the entries in the menu and which items are in which sections.

A menu consists of a map of the following fields:

  • id: the unique, numeric id of this menu
  • name: a unique name for this menu among the menus for a given location; used in the REST API
  • title: the title of the menu. This is displayed to the user as the name of the menu
  • desc: the description of the menu
  • footnote: A note to display at the bottom of the menu in the menu border.
  • state: the state of menu. One of: enabled, disabled
  • disclaimer: the disclaimer text for the menu.
  • attributionImage: URL to the attribution image for this menu
  • attributionImageLink: URL for the link to apply to the attribution image for this menu
  • entries: a list of entry maps (documents).
    • id: the entries ID. This must be a unique ID across all menu entries in the SP systems
    • type: the type of entry. One of: section, item
    • orderNum: the order number for this entry. A one (1) based number.
    • title: the title of the entry. Should be single-lined.
    • name: the unique name of the entry within the menu.
    • desc: the description for the entry. Can be multi-lined.
    • Note: The following values are for item entries
    • prices: if the entry is an item, this is a list of price maps (documents)
      • orderNum: the order number of a price in the list of prices. A one (1) based number.
      • title: the title of a price
      • price: the price itself (just the number, no currency symbol)
      • unit: the price unit. A text field displayed directly after the prices for values like each and per pound.
      • calories: the number of calories for the entry
    • allergens: a list of common allergens in this dish. This list conforms to the standard format of lists [DOCS:as outlined above](#PublisherIntegration-SinglePlatformDataDefinitions-Menus-SPv2-ListFormat). Usually in: egg, fish, dairy, shellfish, soy, peanut, tree nut, wheat
    • allergenFree: a list of common allergens NOT in this dish. This list conforms to the standard format of lists [DOCS:as outlined above](#PublisherIntegration-SinglePlatformDataDefinitions-Menus-SPv2-ListFormat). Usually in: egg-free, fish-free, dairy-free, shellfish-free, soy-free, peanut-free, tree nut-free, gluten-free
    • restrictions: The list of religious, ethical or personal restrictions to which the dish adheres. Includes: halal, kosher, vegan, vegetarian
    • spicy: The level of spiciness at four levels: none, mild, medium, hot

Sample Menu Data

Here is a sample of what a menu would look like.

{
   "location" : {
      "outOfBusiness" : false,
      "general" : {
         "name" : "Banc Cafe",
         "timeZone" : "EST",
         "desc" : "A neighborhood bar restaurant occupying the space of a 1920's bank. The decor is inspired by nineteenth century Parisian establishments. Terra Cotta textured walls, dimly lit chandelier's, copper table tops & curved banquette seating create a very unique and intimate setting. \r\n\r\nExecutive Chef, John J. Loughran formerly of River Cafe in Brooklyn has created a menu that changes seasonally using the best of locally sourced ingredients. Chef John's philosophy, buy local and be creative. This is evident in every dish you taste at Banc Cafe. \r\n\r\nOur cocktails are created using fresh fruit & natural ingredients.We feel that tasty food & flavorful drinks provided with honest friendly service is a great way to win someone over. We hope that someone is you.\r\n\r\nEnjoy!",
         "website" : "http://www.banccafe.com/"
      },
      "phones" : {
         "fax" : "",
         "main" : "2122520146"
      },
      "isOwnerVerified" : true,
      "publishedAt" : "2012-03-09 10:35:56",
      "location" : {
         "region" : "NY",
         "longitude" : -73.97973,
         "country" : "US",
         "address2" : "",
         "latitude" : 40.74351,
         "postcode" : "10016",
         "address1" : "431 3rd Ave",
         "city" : "New York"
      },
      "hours" : {
         "holidaySchedule" : "",
         "fri" : {
            "end" : "04:00am",
            "start" : "11:00am"
         },
         "tue" : {
            "end" : "04:00am",
            "start" : "11:00am"
         },
         "sat" : {
            "start" : "11:00am",
            "end" : "04:00am"
         },
         "thu" : {
            "start" : "11:00am",
            "end" : "04:00am"
         },
         "sun" : {
            "end" : "04:00am",
            "start" : "11:00am"
         },
         "wed" : {
            "end" : "04:00am",
            "start" : "11:00am"
         },
         "mon" : {
            "end" : "04:00am",
            "start" : "11:00am"
         }
      },
      "hasPhotos" : true,
      "id" : "banc-cafe",
      "factualId" : "a2e3baf2-eae4-4017-98d1-1cf4ab02d145",
      "businessType" : "Restaurant"
   },
   "menus" : [
      {
         "footnote" : "",
         "desc" : "",
         "attributionImage" : "http://a.singleplatform.com/SP-DataManagement/banc-cafe/provided_by_2.png",
         "name" : 597359,
         "state" : "enabled",
         "attributionImageLink" : "http://info.singleplatform.com/menu?ref=SP-DataManagement",
         "entries" : [
            {
               "desc" : "Tapas Sampler (choose 4) $34",
               "name" : "tapas--appetizers",
               "type" : "section",
               "title" : "Tapas & Appetizers",
               "id" : "s3328235",
               "orderNum" : 1
            },
            {
               "id" : "24602844",
               "allergenFree" : [],
               "orderNum" : 2,
               "title" : "Meatballs",
               "spicy" : "",
               "restrictions" : [],
               "type" : "item",
               "allergens" : [],
               "desc" : "shiitake mushroom caps, shaved parmesan, espagnole sauce.",
               "prices" : [
                  {
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "10.00"
                  }
               ],
               "name" : "meatballs"
            },
            {
               "name" : "blackened-shrimp",
               "prices" : [
                  {
                     "calories" : "",
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "price" : "13.00"
                  }
               ],
               "desc" : "avocado salad, mango vinaigrette.",
               "allergens" : [],
               "type" : "item",
               "spicy" : "",
               "restrictions" : [],
               "allergenFree" : [],
               "id" : "24602851",
               "title" : "Blackened Shrimp",
               "orderNum" : 3
            },
            {
               "restrictions" : [
                  "vegetarian"
               ],
               "spicy" : "",
               "type" : "item",
               "id" : "24602859",
               "title" : "Vegetable Spring Rolls",
               "allergenFree" : [],
               "orderNum" : 4,
               "name" : "vegetable-spring-rolls",
               "prices" : [
                  {
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "9.00"
                  }
               ],
               "desc" : "sesame ginger vinaigrette.",
               "allergens" : []
            },
            {
               "restrictions" : [],
               "spicy" : "",
               "type" : "item",
               "id" : "24602867",
               "orderNum" : 5,
               "allergenFree" : [],
               "title" : "Lobster Mac N Cheese",
               "desc" : "white cheddar & parmesan, lobster cream sauce.",
               "prices" : [
                  {
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "15.00"
                  },
                  {
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "23.00"
                  }
               ],
               "name" : "lobster-mac-n-cheese",
               "allergens" : []
            },
            {
               "allergenFree" : [],
               "id" : "24602877",
               "orderNum" : 6,
               "title" : "Crab Cakes",
               "spicy" : "",
               "type" : "item",
               "restrictions" : [],
               "prices" : [
                  {
                     "calories" : "",
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "price" : "12.00"
                  }
               ],
               "desc" : "pepper chutney, sweet basil butter sauce.",
               "name" : "crab-cakes",
               "allergens" : []
            },
            {
               "allergens" : [],
               "prices" : [
                  {
                     "price" : "10.00",
                     "calories" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "title" : ""
                  },
                  {
                     "calories" : "",
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "price" : "18.00"
                  }
               ],
               "desc" : "julienne of sun dried tomato, creamy pesto sauce.",
               "name" : "potato-gnocchi",
               "type" : "item",
               "spicy" : "",
               "restrictions" : [
                  "vegetarian"
               ],
               "id" : "24602885",
               "orderNum" : 7,
               "allergenFree" : [],
               "title" : "Potato Gnocchi"
            },
            {
               "title" : "Grilled Chicken Satays",
               "id" : "24602898",
               "allergenFree" : [],
               "orderNum" : 8,
               "type" : "item",
               "spicy" : "",
               "restrictions" : [],
               "allergens" : [],
               "name" : "grilled-chicken-satays",
               "prices" : [
                  {
                     "price" : "9.00",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : "",
                     "calories" : ""
                  }
               ],
               "desc" : "plum dipping sauce."
            },
            {
               "restrictions" : [],
               "spicy" : "",
               "type" : "item",
               "orderNum" : 9,
               "id" : "24602903",
               "allergenFree" : [],
               "title" : "Blackened Scallops",
               "allergens" : [],
               "desc" : "sweetcorn salsa, dill sauce.",
               "prices" : [
                  {
                     "price" : "12.00",
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "calories" : ""
                  }
               ],
               "name" : "blackened-scallops"
            },
            {
               "spicy" : "",
               "restrictions" : [],
               "type" : "item",
               "allergenFree" : [],
               "id" : "24602913",
               "orderNum" : 10,
               "title" : "Coconut Shrimp",
               "allergens" : [],
               "prices" : [
                  {
                     "price" : "14.00",
                     "calories" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "title" : ""
                  }
               ],
               "desc" : "mango & cucumber salsa, tequila, lime dipping sauce.",
               "name" : "coconut-shrimp"
            },
            {
               "allergens" : [],
               "prices" : [
                  {
                     "unit" : "",
                     "orderNum" : "",
                     "title" : "",
                     "calories" : "",
                     "price" : "13.00"
                  }
               ],
               "desc" : "wasabi paste & chilli sauce.",
               "name" : "tartare-of-tuna--avocado",
               "restrictions" : [],
               "spicy" : "",
               "type" : "item",
               "allergenFree" : [],
               "id" : "24602921",
               "orderNum" : 11,
               "title" : "Tartare Of Tuna & Avocado"
            },
            {
               "allergens" : [],
               "name" : "steamed-pei-mussels",
               "desc" : "white wine garlic broth or fra-diavalo.",
               "prices" : [
                  {
                     "price" : "11.00",
                     "calories" : "",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : ""
                  }
               ],
               "type" : "item",
               "spicy" : "",
               "restrictions" : [],
               "allergenFree" : [],
               "id" : "24602928",
               "title" : "Steamed Pei Mussels",
               "orderNum" : 12
            },
            {
               "desc" : "fried shrimp & chicken, ponzo sauce.",
               "prices" : [
                  {
                     "price" : "11.00",
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "calories" : ""
                  }
               ],
               "name" : "dumplings",
               "allergens" : [],
               "allergenFree" : [],
               "id" : "24602935",
               "orderNum" : 13,
               "title" : "Dumplings",
               "restrictions" : [],
               "spicy" : "",
               "type" : "item"
            },
            {
               "prices" : [
                  {
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "10.00"
                  }
               ],
               "desc" : "wasabi scallion dip.",
               "name" : "beef-satays",
               "allergens" : [],
               "title" : "Beef Satays",
               "id" : "24602942",
               "allergenFree" : [],
               "orderNum" : 14,
               "restrictions" : [],
               "spicy" : "",
               "type" : "item"
            },
            {
               "spicy" : "",
               "restrictions" : [],
               "type" : "item",
               "id" : "24602948",
               "allergenFree" : [],
               "orderNum" : 15,
               "title" : "Chicken & Cashew Nut Spring Rolls",
               "allergens" : [],
               "prices" : [
                  {
                     "price" : "10.00",
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "calories" : ""
                  }
               ],
               "desc" : "hot & sweet dipping sauce.",
               "name" : "chicken--cashew-nut-spring-rolls"
            },
            {
               "allergens" : [],
               "prices" : [
                  {
                     "price" : "11.00",
                     "calories" : "",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : ""
                  }
               ],
               "desc" : "warm lentil ragout, baby arugula, white balsamic.",
               "name" : "goat-cheese-stuffed-portabella",
               "spicy" : "",
               "restrictions" : [
                  "vegetarian"
               ],
               "type" : "item",
               "id" : "24602955",
               "title" : "Goat Cheese Stuffed Portabella",
               "allergenFree" : [],
               "orderNum" : 16
            },
            {
               "restrictions" : [],
               "spicy" : "",
               "type" : "item",
               "orderNum" : 17,
               "id" : "24602964",
               "allergenFree" : [],
               "title" : "Classic French Onion Soup",
               "allergens" : [],
               "prices" : [
                  {
                     "calories" : "",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : "",
                     "price" : "6.00"
                  }
               ],
               "desc" : null,
               "name" : "classic-french-onion-soup"
            },
            {
               "name" : "banc-soup-du-jour",
               "desc" : null,
               "prices" : [
                  {
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "6.00"
                  }
               ],
               "allergens" : [],
               "spicy" : "",
               "restrictions" : [],
               "type" : "item",
               "id" : "24602970",
               "orderNum" : 18,
               "allergenFree" : [],
               "title" : "Banc Soup Du Jour"
            },
            {
               "orderNum" : 19,
               "id" : "s3328257",
               "title" : "Salads",
               "type" : "section",
               "name" : "salads",
               "desc" : null
            },
            {
               "allergens" : [],
               "desc" : "wild mushrooms, shaved parmesan, toasted cashew nuts, fig vinaigrette.",
               "prices" : [
                  {
                     "calories" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "title" : "",
                     "price" : "9.00"
                  }
               ],
               "name" : "organic-greens",
               "id" : "24602979",
               "title" : "Organic Greens",
               "allergenFree" : [],
               "orderNum" : 20,
               "spicy" : "",
               "type" : "item",
               "restrictions" : [
                  "vegetarian"
               ]
            },
            {
               "allergens" : [],
               "name" : "chopped-salad",
               "prices" : [
                  {
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "9.00"
                  }
               ],
               "desc" : "french beans, roasted peppers, feta cheese, tomato, portabella, onion & almonds, red wine vinaigrette.",
               "id" : "24602993",
               "title" : "Chopped Salad",
               "allergenFree" : [],
               "orderNum" : 21,
               "spicy" : "",
               "restrictions" : [
                  "vegetarian"
               ],
               "type" : "item"
            },
            {
               "desc" : "shaved reggiano & herb crouton.",
               "prices" : [
                  {
                     "calories" : "",
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "price" : "9.00"
                  }
               ],
               "name" : "classic-caesar",
               "allergens" : [],
               "id" : "24603004",
               "allergenFree" : [],
               "title" : "Classic Caesar",
               "orderNum" : 22,
               "spicy" : "",
               "type" : "item",
               "restrictions" : [
                  "vegetarian"
               ]
            },
            {
               "allergens" : [],
               "prices" : [
                  {
                     "calories" : "",
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "price" : "7.00"
                  }
               ],
               "desc" : "white balsamic vinaigrette.",
               "name" : "mixed-seasonal-greens",
               "spicy" : "",
               "restrictions" : [
                  "vegetarian"
               ],
               "type" : "item",
               "allergenFree" : [],
               "id" : "24603013",
               "orderNum" : 23,
               "title" : "Mixed Seasonal Greens"
            },
            {
               "allergenFree" : [],
               "id" : "24603024",
               "title" : "Country Salad",
               "orderNum" : 24,
               "type" : "item",
               "spicy" : "",
               "restrictions" : [
                  "vegetarian"
               ],
               "allergens" : [],
               "name" : "country-salad",
               "desc" : "boston lettuce, radicchio, endive, apple, gorgonzola, toasted walnuts, apple cider vinaigrette.",
               "prices" : [
                  {
                     "orderNum" : "",
                     "unit" : "",
                     "title" : "",
                     "calories" : "",
                     "price" : "9.00"
                  }
               ]
            },
            {
               "type" : "item",
               "spicy" : "",
               "restrictions" : [
                  "vegetarian"
               ],
               "id" : "24603038",
               "allergenFree" : [],
               "orderNum" : 25,
               "title" : "Fresh Mozzarella & Plum Tomato",
               "allergens" : [],
               "name" : "fresh-mozzarella--plum-tomato",
               "prices" : [
                  {
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "10.00"
                  }
               ],
               "desc" : "fresh basil, evo & aged balsamic."
            },
            {
               "desc" : "baby arugula, frisee, lemon & black pepper vinaigrette.",
               "prices" : [
                  {
                     "price" : "10.00",
                     "calories" : "",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : ""
                  }
               ],
               "name" : "warm-goat-cheese--beet-parfait",
               "allergens" : [],
               "spicy" : "",
               "type" : "item",
               "restrictions" : [
                  "vegetarian"
               ],
               "title" : "Warm Goat Cheese & Beet Parfait",
               "id" : "24603045",
               "allergenFree" : [],
               "orderNum" : 26
            },
            {
               "allergenFree" : [],
               "id" : "24603054",
               "orderNum" : 27,
               "title" : "Chilled Lump Crabmeat Napoleon",
               "restrictions" : [],
               "spicy" : "",
               "type" : "item",
               "prices" : [
                  {
                     "calories" : "",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : "",
                     "price" : "16.00"
                  }
               ],
               "desc" : "baby arugula, shaved fennel, avocado, citrus vinaigrette.",
               "name" : "chilled-lump-crabmeat-napoleon",
               "allergens" : []
            },
            {
               "allergens" : [],
               "prices" : [
                  {
                     "calories" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "title" : "",
                     "price" : "15.00"
                  }
               ],
               "desc" : "over french beans with grilled pear & artichoke, walnut cranberry vinaigrette.",
               "name" : "grilled-chicken-breast",
               "id" : "24603058",
               "orderNum" : 28,
               "allergenFree" : [],
               "title" : "Grilled Chicken Breast",
               "restrictions" : [],
               "spicy" : "",
               "type" : "item"
            },
            {
               "restrictions" : [],
               "spicy" : "",
               "type" : "item",
               "title" : "Thai Beef",
               "id" : "24603063",
               "allergenFree" : [],
               "orderNum" : 29,
               "allergens" : [],
               "name" : "thai-beef",
               "desc" : "baby field greens, cucumber linguine, scallions, mango vinaigrette.",
               "prices" : [
                  {
                     "price" : "15.00",
                     "calories" : "",
                     "title" : "",
                     "unit" : "",
                     "orderNum" : ""
                  }
               ]
            },
            {
               "id" : "s3328269",
               "title" : "Salads - Salad Toppings",
               "orderNum" : 30,
               "desc" : null,
               "name" : "salads---salad-toppings",
               "type" : "section"
            },
            {
               "id" : "24603071",
               "orderNum" : 31,
               "allergenFree" : [],
               "title" : "Chicken",
               "restrictions" : [],
               "spicy" : "",
               "type" : "item",
               "desc" : null,
               "prices" : [
                  {
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "6.00"
                  }
               ],
               "name" : "chicken",
               "allergens" : []
            },
            {
               "name" : "grilled-shrimp",
               "prices" : [
                  {
                     "calories" : "",
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "price" : "10.00"
                  }
               ],
               "desc" : null,
               "allergens" : [],
               "spicy" : "",
               "restrictions" : [],
               "type" : "item",
               "allergenFree" : [],
               "id" : "24603076",
               "title" : "Grilled Shrimp",
               "orderNum" : 32
            },
            {
               "orderNum" : 33,
               "id" : "24603082",
               "allergenFree" : [],
               "title" : "Grilled Salmon",
               "spicy" : "",
               "restrictions" : [],
               "type" : "item",
               "name" : "grilled-salmon",
               "desc" : null,
               "prices" : [
                  {
                     "price" : "9.00",
                     "calories" : "",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : ""
                  }
               ],
               "allergens" : []
            },
            {
               "id" : "24603089",
               "allergenFree" : [],
               "orderNum" : 34,
               "title" : "Crab Cakes",
               "spicy" : "",
               "type" : "item",
               "restrictions" : [],
               "name" : "crab-cakes-34",
               "desc" : null,
               "prices" : [
                  {
                     "unit" : "",
                     "orderNum" : "",
                     "title" : "",
                     "calories" : "",
                     "price" : "9.00"
                  }
               ],
               "allergens" : []
            },
            {
               "desc" : null,
               "type" : "section",
               "name" : "entrees",
               "id" : "s3328274",
               "orderNum" : 35,
               "title" : "Entrees"
            },
            {
               "desc" : "confit leg, wild mushroom risotto, saute spinach, corn niblets, au jus.",
               "prices" : [
                  {
                     "calories" : "",
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "price" : "22.00"
                  }
               ],
               "name" : "roasted-chicken",
               "allergens" : [],
               "spicy" : "",
               "restrictions" : [],
               "type" : "item",
               "allergenFree" : [],
               "id" : "24603097",
               "title" : "Roasted Chicken",
               "orderNum" : 36
            },
            {
               "spicy" : "",
               "restrictions" : [],
               "type" : "item",
               "id" : "24603105",
               "orderNum" : 37,
               "allergenFree" : [],
               "title" : "Braised Lamb Shank",
               "allergens" : [],
               "desc" : "garlic whipped potato, root vegetables, rosemary sauce.",
               "prices" : [
                  {
                     "price" : "22.00",
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "calories" : ""
                  }
               ],
               "name" : "braised-lamb-shank"
            },
            {
               "spicy" : "",
               "restrictions" : [],
               "type" : "item",
               "id" : "24603110",
               "allergenFree" : [],
               "orderNum" : 38,
               "title" : "Angel Hair Pasta",
               "prices" : [
                  {
                     "price" : "19.00",
                     "calories" : "",
                     "title" : "",
                     "unit" : "",
                     "orderNum" : ""
                  }
               ],
               "desc" : "saute chicken, spinach, roasted peppers, english peas, vodka pink sauce.",
               "name" : "angel-hair-pasta",
               "allergens" : []
            },
            {
               "desc" : "sweet potato & shrimp hash, asparagus, tomato caper butter sauce.",
               "prices" : [
                  {
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "21.00"
                  }
               ],
               "name" : "baked-new-england-cod",
               "allergens" : [],
               "spicy" : "",
               "restrictions" : [],
               "type" : "item",
               "id" : "24603117",
               "orderNum" : 39,
               "allergenFree" : [],
               "title" : "Baked New England Cod"
            },
            {
               "id" : "24603124",
               "allergenFree" : [],
               "orderNum" : 40,
               "title" : "Pistachio Crusted Chicken Breast",
               "restrictions" : [],
               "spicy" : "",
               "type" : "item",
               "name" : "pistachio-crusted-chicken-breast",
               "prices" : [
                  {
                     "price" : "19.00",
                     "calories" : "",
                     "title" : "",
                     "unit" : "",
                     "orderNum" : ""
                  }
               ],
               "desc" : "buttermilk whipped potato, green beans, port wine sauce.",
               "allergens" : []
            },
            {
               "desc" : "rock shrimp & calamari, lobster sautern sauce.",
               "prices" : [
                  {
                     "price" : "22.00",
                     "calories" : "",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : ""
                  }
               ],
               "name" : "lobster-ravioli",
               "allergens" : [],
               "spicy" : "",
               "restrictions" : [],
               "type" : "item",
               "allergenFree" : [],
               "id" : "24603131",
               "title" : "Lobster Ravioli",
               "orderNum" : 41
            },
            {
               "id" : "24603140",
               "allergenFree" : [],
               "title" : "Filet Mignon",
               "orderNum" : 42,
               "spicy" : "",
               "restrictions" : [],
               "type" : "item",
               "name" : "filet-mignon",
               "desc" : "(available pepper crusted) twice baked roquefort potato, roast asparagus spears, classic au poivre sauce.",
               "prices" : [
                  {
                     "price" : "32.00",
                     "calories" : "",
                     "unit" : "",
                     "title" : "",
                     "orderNum" : ""
                  }
               ],
               "allergens" : []
            },
            {
               "allergens" : [],
               "desc" : "carmelized onion sauce.",
               "prices" : [
                  {
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "20.00"
                  }
               ],
               "name" : "skirt-steak-frites",
               "orderNum" : 43,
               "id" : "24603147",
               "allergenFree" : [],
               "title" : "Skirt Steak Frites",
               "spicy" : "",
               "restrictions" : [],
               "type" : "item"
            },
            {
               "allergens" : [],
               "prices" : [
                  {
                     "price" : "23.00",
                     "calories" : "",
                     "title" : "",
                     "unit" : "",
                     "orderNum" : ""
                  }
               ],
               "desc" : "jasmine rice, snow peas & leeks, ginger soy buerre blanc.",
               "name" : "sesame-crusted-salmon",
               "restrictions" : [],
               "spicy" : "",
               "type" : "item",
               "orderNum" : 44,
               "id" : "24603155",
               "allergenFree" : [],
               "title" : "Sesame Crusted Salmon"
            },
            {
               "allergens" : [],
               "name" : "saute-jumbo-shrimp--sea-scallops",
               "desc" : "smoked bacon & butternut risotto, asparagus, herb butter sauce.",
               "prices" : [
                  {
                     "price" : "22.00",
                     "calories" : "",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : ""
                  }
               ],
               "id" : "24603163",
               "allergenFree" : [],
               "title" : "Saute Jumbo Shrimp & Sea Scallops",
               "orderNum" : 45,
               "spicy" : "",
               "restrictions" : [],
               "type" : "item"
            },
            {
               "orderNum" : 46,
               "id" : "s3328285",
               "title" : "Vegetarian",
               "type" : "section",
               "name" : "vegetarian",
               "desc" : null
            },
            {
               "spicy" : "",
               "type" : "item",
               "restrictions" : [
                  "vegetarian"
               ],
               "id" : "24603173",
               "allergenFree" : [],
               "title" : "Wholewheat Linguine Pasta",
               "orderNum" : 47,
               "name" : "wholewheat-linguine-pasta",
               "prices" : [
                  {
                     "unit" : "",
                     "orderNum" : "",
                     "title" : "",
                     "calories" : "",
                     "price" : "17.00"
                  }
               ],
               "desc" : "saute vegetables, roasted garlic parmesan broth.",
               "allergens" : []
            },
            {
               "allergenFree" : [],
               "id" : "24603181",
               "orderNum" : 48,
               "title" : "Eggplant Parmigiana",
               "spicy" : "",
               "type" : "item",
               "restrictions" : [
                  "vegetarian"
               ],
               "allergens" : [],
               "name" : "eggplant-parmigiana",
               "desc" : "napoleon of eggplant, mozzarella, portabella, parmesan cheese & marinara sauce.",
               "prices" : [
                  {
                     "calories" : "",
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "price" : "17.00"
                  }
               ]
            },
            {
               "allergens" : [],
               "name" : "vegetable-plate",
               "prices" : [
                  {
                     "price" : "13.00",
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "calories" : ""
                  }
               ],
               "desc" : "assorted garden vegetables sauteed with garlic & olive oil or plain steamed with spring rice blend.",
               "allergenFree" : [],
               "id" : "24603189",
               "title" : "Vegetable Plate",
               "orderNum" : 49,
               "spicy" : "",
               "restrictions" : [
                  "vegetarian"
               ],
               "type" : "item"
            },
            {
               "spicy" : "",
               "type" : "item",
               "restrictions" : [
                  "vegetarian"
               ],
               "orderNum" : 50,
               "id" : "24603197",
               "allergenFree" : [],
               "title" : "Butternut Squash Ravioli",
               "desc" : "diced butternut & english peas, alfredo sauce.",
               "prices" : [
                  {
                     "calories" : "",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : "",
                     "price" : "17.00"
                  }
               ],
               "name" : "butternut-squash-ravioli",
               "allergens" : []
            },
            {
               "orderNum" : 51,
               "id" : "s3328288",
               "title" : "Casual Fare",
               "desc" : null,
               "name" : "casual-fare",
               "type" : "section"
            },
            {
               "allergens" : [],
               "prices" : [
                  {
                     "calories" : "",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : "",
                     "price" : "15.00"
                  }
               ],
               "desc" : "freshly ground sirloin, peas, carrots & onions topped with toasted mashed potatoes.",
               "name" : "shepherds-pie",
               "id" : "24603206",
               "allergenFree" : [],
               "orderNum" : 52,
               "title" : "Shepherds Pie",
               "spicy" : "",
               "restrictions" : [],
               "type" : "item"
            },
            {
               "prices" : [
                  {
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "16.00"
                  }
               ],
               "desc" : "open faced, saute onions, grilled portabella, glazed gorgonzola, horseradish mayo & french fries.",
               "name" : "filet-mignon-baguette",
               "allergens" : [],
               "id" : "24603212",
               "allergenFree" : [],
               "orderNum" : 53,
               "title" : "Filet Mignon Baguette",
               "restrictions" : [],
               "spicy" : "",
               "type" : "item"
            },
            {
               "allergens" : [],
               "prices" : [
                  {
                     "unit" : "",
                     "title" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "14.00"
                  }
               ],
               "desc" : "cajun dusted chopped sirloin, portabella, roasted peppers, goat cheese, crispy bacon, chipotle mayo, french fries.",
               "name" : "banc-signature-burger",
               "allergenFree" : [],
               "id" : "24603216",
               "title" : "Banc Signature Burger",
               "orderNum" : 54,
               "spicy" : "",
               "type" : "item",
               "restrictions" : []
            },
            {
               "allergens" : [],
               "name" : "chopped-sirloin-burger",
               "prices" : [
                  {
                     "price" : "12.00",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : "",
                     "calories" : ""
                  }
               ],
               "desc" : "choice of toppings & french fries.",
               "type" : "item",
               "spicy" : "",
               "restrictions" : [],
               "allergenFree" : [],
               "id" : "24603222",
               "title" : "Chopped Sirloin Burger",
               "orderNum" : 55
            },
            {
               "allergens" : [],
               "desc" : "choice of toppings & sweet potato fries.",
               "prices" : [
                  {
                     "calories" : "",
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "price" : "12.00"
                  }
               ],
               "name" : "homemade-vegetarian-burger",
               "id" : "24603227",
               "title" : "Homemade Vegetarian Burger",
               "allergenFree" : [],
               "orderNum" : 56,
               "restrictions" : [],
               "spicy" : "",
               "type" : "item"
            },
            {
               "name" : "sides",
               "type" : "section",
               "desc" : null,
               "title" : "Sides",
               "id" : "s3328290",
               "orderNum" : 57
            },
            {
               "orderNum" : 58,
               "id" : "24603232",
               "allergenFree" : [],
               "title" : "Brussels Sprouts",
               "restrictions" : [],
               "spicy" : "",
               "type" : "item",
               "prices" : [
                  {
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "calories" : "",
                     "price" : "6.00"
                  }
               ],
               "desc" : "with smoked bacon & onions",
               "name" : "brussels-sprouts",
               "allergens" : []
            },
            {
               "restrictions" : [
                  "vegetarian"
               ],
               "spicy" : "",
               "type" : "item",
               "id" : "24603238",
               "allergenFree" : [],
               "orderNum" : 59,
               "title" : "Sweet Potato Hash",
               "allergens" : [],
               "name" : "sweet-potato-hash",
               "prices" : [
                  {
                     "price" : "6.00",
                     "calories" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "title" : ""
                  }
               ],
               "desc" : null
            },
            {
               "allergenFree" : [],
               "id" : "24603245",
               "title" : "Pan Roasted French Bean & Grape Tomatoes",
               "orderNum" : 60,
               "spicy" : "",
               "restrictions" : [
                  "vegetarian"
               ],
               "type" : "item",
               "allergens" : [],
               "prices" : [
                  {
                     "price" : "6.00",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : "",
                     "calories" : ""
                  }
               ],
               "desc" : null,
               "name" : "pan-roasted-french-bean--grape-tomatoes"
            },
            {
               "name" : "parmesan-dusted-french-fries",
               "desc" : null,
               "prices" : [
                  {
                     "price" : "6.00",
                     "calories" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "title" : ""
                  }
               ],
               "allergens" : [],
               "spicy" : "",
               "restrictions" : [
                  "vegetarian"
               ],
               "type" : "item",
               "id" : "24603251",
               "title" : "Parmesan Dusted French Fries",
               "allergenFree" : [],
               "orderNum" : 61
            },
            {
               "allergens" : [],
               "name" : "sweet-potato-fries",
               "prices" : [
                  {
                     "calories" : "",
                     "title" : "",
                     "unit" : "",
                     "orderNum" : "",
                     "price" : "6.00"
                  }
               ],
               "desc" : null,
               "spicy" : "",
               "restrictions" : [
                  "vegetarian"
               ],
               "type" : "item",
               "orderNum" : 62,
               "id" : "24603257",
               "allergenFree" : [],
               "title" : "Sweet Potato Fries"
            },
            {
               "prices" : [
                  {
                     "price" : "6.00",
                     "calories" : "",
                     "orderNum" : "",
                     "unit" : "",
                     "title" : ""
                  }
               ],
               "desc" : null,
               "name" : "mac-n-cheese",
               "allergens" : [],
               "allergenFree" : [],
               "id" : "24603262",
               "orderNum" : 63,
               "title" : "Mac N Cheese",
               "spicy" : "",
               "restrictions" : [
                  "vegetarian"
               ],
               "type" : "item"
            }
         ],
         "disclaimer" : "Disclaimer: Always check with the business for pricing and availability of menu items. SinglePlatform is not responsible for menu or pricing changes, but the information is believed to be accurate when posted. Listing of a menu does not mean that there is any affiliation, endorsement or sponsorship between SinglePlatform and the listed business.",
         "secureAttributionImage" : "https://as.singleplatform.com/SP-DataManagement/banc-cafe/provided_by_2.png",
         "secureAttributionImageLink" : "http://info.singleplatform.com/menu?ref=SP-DataManagement",
         "id" : "m1x58k1njygsubjzfwgak5djn",
         "title" : "Dinner Menu"
      }
   ],
   "locationToMenus" : {
      "locationId" : "banc-cafe",
      "locationToMenus" : [
         {
            "state" : "enabled",
            "id" : "m1x58k1njygsubjzfwgak5djn",
            "orderNum" : "0",
            "name" : "597359"
         }
      ]
   }
}

Short Menu Field Descriptions

A couple notes to help in understanding the field descriptions below:

  • There are multiple types of entries. Each entry type contains a slightly different set of information and is/should be rendered slightly differently.
  • The list of entries is ordered by the orderNum field. The ordering is important as it defines the order in which to render the entries in the menu and which items are in which sections.

A menu consists of a map of the following fields:

  • title: the title of the menu. This is displayed to the user as the name of the menu
  • desc: the description of the menu
  • footnote: A note to display at the bottom of the menu in the menu border.
  • attributionImage: URL to the attribution image for this menu
  • attributionImageLink: URL for the link to apply to the attribution image for this menu
  • entries: a list of entry maps (documents).
    • id: the entries ID. This must be a unique ID across all menu entries in the SP systems
    • type: the type of entry. One of: section, item
    • orderNum: the order number for this entry. A one (1) based number.
    • title: the title of the entry. Should be single-lined.
    • name: the unique name of the entry within the menu.
    • desc: the description for the entry. Can be multi-lined.
    • Note: The following values are for item entries
    • prices: if the entry is an item, this is a list of price maps (documents)
      • orderNum: the order number of a price in the list of prices. A one (1) based number.
      • title: the title of a price
      • price: the price itself (just the number, no currency symbol)
      • unit: the price unit. A text field displayed directly after the prices for values like each and per pound.
      • calories: the number of calories for the entry
    • allergens: a list of common allergens in this dish. This list conforms to the standard format of lists. Usually in: egg, fish, dairy, shellfish, soy, peanut, tree nut, wheat
    • allergenFree: a list of common allergens NOT in this dish. This list conforms to the standard format of lists. Usually in: egg-free, fish-free, dairy-free, shellfish-free, soy-free, peanut-free, tree nut-free, gluten-free
    • restrictions: The list of religious, ethical or personal restrictions to which the dish adheres. Includes: halal, kosher, vegan, vegetarian
    • spicy: The level of spiciness at four levels: none, mild, medium, hot