Show Menu

Provider Enablement / Endpoints

Show Menu

Our menu structure attempts to make it easy to represent almost any menu cleanly within the LevelUp format, with a limited amount of translation/manipulation. Ascribing to this format makes it seamless for LevelUp to feature your merchants ordering experience in the LevelUp, a merchant-specific app we power, or any of our partner apps such as Chase Pay.

LevelUp’s menu structure affords you a lot of flexibility in terms of how you choose to represent a menu, and what information you include such as images and nutritional info. If you have specific questions about how to best represent your menu, please email developer@thelevelup.com and we’ll provide advice.

Request Endpoint

GET /locations/:provider_location_id/menu

Example Response Body

{
  "menu": {
    "allows_special_instructions": true,
    "special_instructions_character_limit": 100,
    "provider_id": "35c5e14a-2dc4-4972-8f1a-151b428495d9",
    "name": "Octoburgers_menu",
    "updated_at": "2016-05-31T16:07:55-04:00",
    "option_groups": [
      {
        "option_group": {
          "provider_id": "c9f34ae3-03e7-48d3-b8e3-d47a669d4c4b",
          "name": "Bun",
          "minimum_choices": 1,
          "maximum_choices": 1,
          "options": [
            {
              "option": {
                "provider_id": "8ff532bf-c3db-4e2e-be3c-fe246be60f94",
                "name": "White",
                "price": 0
              }
            },
            {
              "option": {
                "provider_id": "38ff254b-4785-41d5-854d-ed7b1f1a62a6",
                "name": "Whole Wheat",
                "price": 0
              }
            },
            {
              "option": {
                "provider_id": "3bc422c8-f199-4006-91e1-1fa4a067dab4",
                "name": "Portobello Mushroom",
                "price": 299
              }
            },
            {
              "option": {
                "provider_id": "359972a7-63ee-4c45-ad36-88a3e2efa0b1",
                "name": "Soft Pretzel",
                "price": 349
              }
            }
          ],
          "defaults": [
            "8ff532bf-c3db-4e2e-be3c-fe246be60f94"
          ]
        }
      },
      {
        "option_group": {
          "provider_id": "ccc9e5b7-0b98-4e1e-bb83-887625989c4e",
          "name": "Patties",
          "minimum_choices": 1,
          "maximum_choices": 1,
          "options": [
            {
              "option": {
                "provider_id": "b86dac3e-f192-4b0b-a085-64f6b5d9ef8a",
                "name": "The Lone Patty",
                "price": 0
              }
            },
            {
              "option": {
                "provider_id": "6282c5ad-e912-4772-86e5-70aff4b09365",
                "name": "Double the Patty, Double the Fun",
                "price": 100
              }
            },
            {
              "option": {
                "provider_id": "12ceb592-1a81-46b4-9464-9ba7d190e20f",
                "name": "Three's a Crowded Burger",
                "price": 200
              }
            },
            {
              "option": {
                "provider_id": "10887107-a0e8-4f76-a371-c819bff8622d",
                "name": "The Octopatty",
                "price": 800
              }
            }
          ],
          "defaults": [
            "b86dac3e-f192-4b0b-a085-64f6b5d9ef8a"
          ]
        }
      },
      {
        "option_group": {
          "provider_id": "8708454a-f7a9-47ee-b20b-92e97da2a3f9",
          "name": "Toppings",
          "minimum_choices": 1,
          "maximum_choices": 5,
          "minimum_unique_options": 1,
          "maximum_unique_options": 3,
          "options": [
            {
              "option": {
                "provider_id": "b44e3e11-3a9d-41af-8351-a7d7252485ca",
                "name": "Alfalfa Sprouts",
                "price": 49
              }
            },
            {
              "option": {
                "provider_id": "c1881fac-b3b0-4cf8-84a0-838aafd03d55",
                "name": "American Cheese",
                "price": 0
              }
            },
            {
              "option": {
                "provider_id": "364779b8-5b4b-4849-ad51-debefc41f29b",
                "name": "Avocado",
                "price": 49
              }
            },
            {
              "option": {
                "provider_id": "c3699423-71e7-4a98-8222-d21dadc0d620",
                "name": "Bacon",
                "price": 49
              }
            },
            {
              "option": {
                "provider_id": "d1469214-de87-4ce7-ae16-e5b976d3eb77",
                "name": "Barbecue Sauce",
                "price": 10
              }
            },
            {
              "option": {
                "provider_id": "54552c54-d092-44c6-8870-a50f923c7893",
                "name": "Blue Cheese",
                "price": 10
              }
            },
            {
              "option": {
                "provider_id": "9517433e-327b-4191-a9a9-c3306cdec6ed",
                "name": "Cheddar Cheese",
                "price": 0
              }
            },
            {
              "option": {
                "provider_id": "bae7ee52-3155-40b4-ad58-ddad55f79e01",
                "name": "Fried Egg",
                "price": 149,
                "option_groups": [
                  "8708454a-f7a9-47ee-b20b-92e97da2a3f9"
                ],
                "maximum_quantity": 3,
                "default_quantity": 2
              }
            },
            {
              "option": {
                "provider_id": "3190971a-f9d8-4c5a-8539-dd9a031d467a",
                "name": "Grilled Bell Peppers",
                "price": 49
              }
            },
            {
              "option": {
                "provider_id": "fe08316d-8d5f-4090-8d85-2ef132cde946",
                "name": "Grilled Onions",
                "price": 10
              }
            },
            {
              "option": {
                "provider_id": "6bd09baf-9d0e-48cf-89f8-f19cb37bcace",
                "name": "Jalapeños",
                "price": 49
              }
            },
            {
              "option": {
                "provider_id": "fadbf878-5692-4db2-92d9-21a007f63876",
                "name": "Onion Rings",
                "price": 149
              }
            },
            {
              "option": {
                "provider_id": "19f88084-16c9-466a-a835-182272da8a46",
                "name": "Pepper Jack Cheese",
                "price": 10
              }
            }
          ]
        }
      },
      {
        "option_group": {
          "provider_id": "8708454a-f7a9-47ee-b20b-92e97da2a3f9",
          "name": "Egg Style",
          "minimum_choices": 1,
          "maximum_choices": 1,
          "options": [
            {
              "option": {
                "provider_id": "a7d72524-8351-41af-3a9d-b44e3e1185ca",
                "name": "Over Easy",
                "price": 0
              }
            },
            {
              "option": {
                "provider_id": "838aafd0-84a0-4cf8-b3b0-c1881fac3d55",
                "name": "Over Medium",
                "price": 0
              }
            },
            {
              "option": {
                "provider_id": "debefc41-ad51-4849-5b4b-364779b8f29b",
                "name": "Over Hard",
                "price": 49
              }
            }
          ]
        }
      }
    ],
    "categories": [
      {
        "category": {
          "provider_id": "ce70838c-2333-4d76-8c87-6720e0a24a47",
          "name": "Burgers",
          "description": "Meat or veggies, we'll grill it all and slap it between two buns!",
          "items": [
            {
              "item": {
                "provider_id": "77080b92-fcf3-4c86-9df8-2f434d17f153",
                "name": "The Octoburger",
                "description": "Premium Massachusetts beef fed with South Dakota corn.",
                "metadata": {
                  "integration-id_for_validation": "123"
                },
                "price": 450,
                "option_groups": [
                  "c9f34ae3-03e7-48d3-b8e3-d47a669d4c4b",
                  "ccc9e5b7-0b98-4e1e-bb83-887625989c4e",
                  "8708454a-f7a9-47ee-b20b-92e97da2a3f9"
                ],
                "image": "http://i.imgur.com/7Dn4Hav.jpg",
                "nutrition": {
                  "calories": 690
                },
                "allows_special_instructions": true,
                "special_instructions_character_limit": 50
              }
            },
            {
              "item": {
                "provider_id": "e9887853-338f-4094-9f69-eaf3b5e69427",
                "name": "The Octoveg",
                "description": "A grilled lentil patty infused with bits of grilled bell pepper.",
                "nutrition": {
                  "caloric_description": "850 cal – 1100 cal",
                  "calories": 690,
                  "calories_from_fat": 100,
                  "carbohydrates": 90,
                  "dietary_fiber": 80,
                  "ingredient_description": "Lentils, Grilled Bell Peppers",
                  "protein": 70,
                  "saturated_fat": 60,
                  "sodium": 50,
                  "sugars": 40,
                  "tags": [
                    "Egg",
                    "Milk",
                    "Wheat",
                    "Soybeans",
                    "Tree Nuts",
                    "Peanuts",
                    "Shellfish",
                    "Fish",
                    "Vegan",
                    "Kosher"
                  ],
                  "trans_fat": 30
                },
                "price": 450,
                "option_groups": [
                  "c9f34ae3-03e7-48d3-b8e3-d47a669d4c4b",
                  "ccc9e5b7-0b98-4e1e-bb83-887625989c4e",
                  "8708454a-f7a9-47ee-b20b-92e97da2a3f9"
                ],
                "image": "http://i.imgur.com/KTNsrtb.jpg",
                "nutrition": {
                  "calories": 420
                },
                "allows_special_instructions": true,
                "special_instructions_character_limit": 50
              }
            },
            {
              "item": {
                "provider_id": "e9887853-338f-4094-9f69-eaf3b5e69427",
                "name": "The Octobreakfast",
                "description": "A breakfast burger made with breakfast and bacon. Served all day on weekends.",
                "price": 450,
                "option_groups": [
                  "c9f34ae3-03e7-48d3-b8e3-d47a669d4c4b",
                  "ccc9e5b7-0b98-4e1e-bb83-887625989c4e",
                  "8708454a-f7a9-47ee-b20b-92e97da2a3f9"
                ],
                "image": "http://i.imgur.com/XjsqVh.jpg",
                "nutrition": {
                  "calories": 900
                },
                "allows_special_instructions": true,
                "special_instructions_character_limit": 50,
                "timescopes": [
                  {
                    "time_of_day_ends_at" : "12:00",
                    "time_of_day_starts_at" : "7:00",
                    "day_of_week_ends_at" : "Monday",
                    "day_of_week_starts_at" : "Friday",
                    "date_ends_at" : null,
                    "date_starts_at" : null
                  },
                  {
                    "time_of_day_ends_at" : "17:00",
                    "time_of_day_starts_at" : "7:00",
                    "day_of_week_ends_at" : "Saturday",
                    "day_of_week_starts_at" : "Sunday",
                    "date_ends_at" : null,
                    "date_starts_at" : null
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "category": {
          "provider_id": "19bbd685-ddb9-4469-bed2-a33a81aeebb5",
          "name": "Beer",
          "description": "Quench your burger thirst with an ice-cold beer.",
          "items": [
            {
              "item": {
                "provider_id": "cc87779f-c32b-422f-9486-77099fd81e1f",
                "name": "Guinness",
                "description": "A pint of the classic Irish dry stout.",
                "price": 249,
                "image": "http://i.imgur.com/RAg20zt.jpg",
                "nutrition": {
                  "calories": 210
                },
                "allows_special_instructions": false
              }
            },
            {
              "item": {
                "provider_id": "9b8b66e8-26a2-4f01-b862-39f109df4686",
                "name": "Harpoon IPA",
                "description": "It's good stuff.",
                "price": 199,
                "image": "http://i.imgur.com/fZ74WMr.jpg",
                "nutrition": {
                  "calories": 0
                },
                "allows_special_instructions": false
              }
            }
          ],
          "category_group": "29bfd636-eyb9-7130-bed2-a3ajb5aee44p",
          "timescopes": [
            {
              "time_of_day_ends_at" : "23:00",
              "time_of_day_starts_at" : "17:00",
              "day_of_week_ends_at" : null,
              "day_of_week_starts_at" : null,
              "date_ends_at" : null,
              "date_starts_at" : null
            }
          ]
        }
      },
      {
        "category": {
          "provider_id": "19bbd685-ddb9-4469-bed2-a33a81aeebb5",
          "name": "Smoothies",
          "description": "Quench your burger thirst with an ice-cold beer.",
          "items": [
            {
              "item": {
                "provider_id": "9b8b66e8-ddb9-422f-9486-26a29fd81d4f",
                "name": "Strawberry Banana Smoothie",
                "description": "A tropical mix of fruity goodness.",
                "price": 499,
                "image": "http://i.imgur.com/RAg20zt.jpg",
                "nutrition": {
                  "calories": 210
                },
                "allows_special_instructions": true,
                "special_instructions_character_limit": 75
              }
            }
          ],
          "category_group": "29bfd636-eyb9-7130-bed2-a3ajb5aee44p"
        }
      }
    ],
    "category_groups": [
      {
        "category_group": {
          "provider_id": "29bfd636-eyb9-7130-bed2-a3ajb5aee44p",
          "name": "Drinks",
          "description": "They go down smooth."
        }
      }
    ]
  }
}

Example Response Schema

{
  "type": "object",
  "properties": {
    "menu": {
      "description": "A representation of a menu for a specific merchant and location",
      "type": "object",
      "properties": {
        "name": {
          "description": "The title of the menu (e.g. Burger King Summer St)",
          "type": "string"
        },
        "provider_id": {
          "description": "A unique string that identifies the menu",
          "type": "string"
        },
        "allows_special_instructions": {
          "description": "Whether or not a user may input special instructions to be sent along with their order",
          "type": "boolean"
        },
        "special_instructions_character_limit": {
          "description": "The maximum number of characters that the provider accepts for the special instructions (required if allows_special_instructions is true)",
          "type": "number"
        },
        "timescopes": {
          "type": "array",
          "items": {
            "type": "object",
            "title": "timescope",
            "properties": {
              "time_of_day_starts_at": {
                "type": "string"
              },
              "time_of_day_ends_at": {
                "type": "string"
              },
              "day_of_week_starts_at": {
                "type": "string"
              },
              "day_of_week_ends_at": {
                "type": "string"
              },
              "date_starts_at": {
                "type": "string"
              },
              "date_ends_at": {
                "type": "string"
              }
            },
            "dependencies": {
              "time_of_day_ends_at": [
                "time_of_day_starts_at"
              ],
              "time_of_day_starts_at": [
                "time_of_day_ends_at"
              ],
              "day_of_week_ends_at": [
                "day_of_week_starts_at"
              ],
              "day_of_week_starts_at": [
                "day_of_week_ends_at"
              ],
              "date_ends_at": [
                "date_starts_at"
              ],
              "date_starts_at": [
                "date_ends_at"
              ]
            }
          }
        },
        "updated_at": {
          "description": "An iso8601 timestamp representing when the menu was last updated, in UTC",
          "type" : "string"
        },
        "categories": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "category": {
                "description": "A collection of individual items (e.g. Smoothies)",
                "type": "object",
                "properties": {
                  "description": {
                    "description": "A description of the category scraped from the provider",
                    "type": "string"
                  },
                  "name": {
                    "description": "The name of the category (e.g. Smoothies)",
                    "type": "string"
                  },
                  "provider_id": {
                    "description": "A unique ID (or XPath selector) for this element",
                    "type": "string"
                  },
                  "category_group": {
                    "description": "The id of the category group to which the category belongs",
                    "type": "string"
                  },
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "item": {
                          "description": "A specific thing on a menu (e.g. Banana Smoothie)",
                          "type": "object",
                          "properties": {
                            "allows_special_instructions": {
                              "description": "Whether or not a user may input special instructions to be sent along with this specific item",
                              "type": "boolean"
                            },
                            "description": {
                              "description": "A description of the item scraped from the provider",
                              "type": "string"
                            },
                            "image": {
                              "description": "The URL for an image associated with the item",
                              "type": "string"
                            },
                            "metadata": {
                              "description": "Any keys prefixed with integration- will be passed back to the provider during order validation and submission",
                              "type": "object"
                            },
                            "name": {
                              "description": "The name of the item",
                              "type": "string"
                            },
                            "nutrition": {
                              "description": "Calorie and other nutrition information",
                              "type": "object",
                              "properties": {
                                "caloric_description": {
                                  "type": "string",
                                  "description": "Range of calories for a menu item (e.g. '850 cal - 1100 cal')"
                                },
                                "calories": {
                                  "type": "integer",
                                  "description": "Calories in the menu item"
                                },
                                "calories_from_fat": {
                                  "type": "integer",
                                  "description": "Calories from fat in the menu item"
                                },
                                "carbohydrates": {
                                  "type": "integer",
                                  "description": "Carbohydrates in the menu item"
                                },
                                "dietary_fiber": {
                                  "type": "integer",
                                  "description": "Dietary fiber in the menu item"
                                },
                                "ingredient_description": {
                                  "type": "string",
                                  "description": "Ingredients in the menu item"
                                },
                                "protein": {
                                  "type": "integer",
                                  "description": "Protein in the menu item"
                                },
                                "saturated_fat": {
                                  "type": "integer",
                                  "description": "Saturated fat in the menu item"
                                },
                                "sodium": {
                                  "type": "integer",
                                  "description": "Sodium in the menu item"
                                },
                                "sugars": {
                                  "type": "integer",
                                  "description": "Sugars in the menu item"
                                },
                                "tags": {
                                  "type": "array",
                                  "items": {
                                    "description": "Tags for the menu item",
                                    "type": "string"
                                  }
                                },
                                "trans_fat": {
                                  "type": "integer",
                                  "description": "Trans fat in the menu item"
                                }
                              }
                            },
                            "option_groups": {
                              "type": "array",
                              "items": {
                                "description": "The provider id for an option group that the item includes",
                                "type": "string"
                              }
                            },
                            "price": {
                              "description": "The cost of the item in cents",
                              "type": "number"
                            },
                            "provider_id": {
                              "description": "A unique ID (or XPath selector) for this element",
                              "type": "string"
                            },
                            "special_instructions_character_limit": {
                              "description": "The maximum number of characters that the provider accepts for the special instructions (required if allows_special_instructions is true)",
                              "type": "number"
                            },
                            "timescopes": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "title": "timescope",
                                "properties": {
                                  "time_of_day_starts_at": {
                                    "type": "string"
                                  },
                                  "time_of_day_ends_at": {
                                    "type": "string"
                                  },
                                  "day_of_week_starts_at": {
                                    "type": "string"
                                  },
                                  "day_of_week_ends_at": {
                                    "type": "string"
                                  },
                                  "date_starts_at": {
                                    "type": "string"
                                  },
                                  "date_ends_at": {
                                    "type": "string"
                                  }
                                },
                                "dependencies": {
                                  "time_of_day_ends_at": [
                                    "time_of_day_starts_at"
                                  ],
                                  "time_of_day_starts_at": [
                                    "time_of_day_ends_at"
                                  ],
                                  "day_of_week_ends_at": [
                                    "day_of_week_starts_at"
                                  ],
                                  "day_of_week_starts_at": [
                                    "day_of_week_ends_at"
                                  ],
                                  "date_ends_at": [
                                    "date_starts_at"
                                  ],
                                  "date_starts_at": [
                                    "date_ends_at"
                                  ]
                                }
                              }
                            }
                          },
                          "required" : [
                            "name",
                            "price",
                            "provider_id"
                          ]
                        }
                      },
                      "required": [
                        "item"
                      ]
                    }
                  },
                  "timescopes": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "title": "timescope",
                      "properties": {
                        "time_of_day_starts_at": {
                          "type": "string"
                        },
                        "time_of_day_ends_at": {
                          "type": "string"
                        },
                        "day_of_week_starts_at": {
                          "type": "string"
                        },
                        "day_of_week_ends_at": {
                          "type": "string"
                        },
                        "date_starts_at": {
                          "type": "string"
                        },
                        "date_ends_at": {
                          "type": "string"
                        }
                      },
                      "dependencies": {
                        "time_of_day_ends_at": [
                          "time_of_day_starts_at"
                        ],
                        "time_of_day_starts_at": [
                          "time_of_day_ends_at"
                        ],
                        "day_of_week_ends_at": [
                          "day_of_week_starts_at"
                        ],
                        "day_of_week_starts_at": [
                          "day_of_week_ends_at"
                        ],
                        "date_ends_at": [
                          "date_starts_at"
                        ],
                        "date_starts_at": [
                          "date_ends_at"
                        ]
                      }
                    }
                  }
                },
                "required": [
                  "items",
                  "name",
                  "provider_id"
                ]
              }
            }
          }
        },
        "category_groups": {
          "type": "array",
          "items": {
            "description": "A collection into which a category fits (e.g. Beverages)",
            "type": "object",
            "properties": {
              "category_group": {
                "type": "object",
                "properties": {
                  "description": {
                    "description": "A description of the category group scraped from the provider",
                    "type": "string"
                  },
                  "name": {
                    "description": "The name of the category group (e.g. Beverages)",
                    "type": "string"
                  },
                  "provider_id": {
                    "description": "A unique ID (or XPath selector) for this element",
                    "type": "string"
                  },
                  "timescopes": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "title": "timescope",
                      "properties": {
                        "time_of_day_starts_at": {
                          "type": "string"
                        },
                        "time_of_day_ends_at": {
                          "type": "string"
                        },
                        "day_of_week_starts_at": {
                          "type": "string"
                        },
                        "day_of_week_ends_at": {
                          "type": "string"
                        },
                        "date_starts_at": {
                          "type": "string"
                        },
                        "date_ends_at": {
                          "type": "string"
                        }
                      },
                      "dependencies": {
                        "time_of_day_ends_at": [
                          "time_of_day_starts_at"
                        ],
                        "time_of_day_starts_at": [
                          "time_of_day_ends_at"
                        ],
                        "day_of_week_ends_at": [
                          "day_of_week_starts_at"
                        ],
                        "day_of_week_starts_at": [
                          "day_of_week_ends_at"
                        ],
                        "date_ends_at": [
                          "date_starts_at"
                        ],
                        "date_starts_at": [
                          "date_ends_at"
                        ]
                      }
                    }
                  }
                },
                "required": [
                  "provider_id",
                  "name"
                ]
              }
            }
          }
        },
        "option_groups": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "option_group": {
                "description": "A collection of item options (e.g. Size)",
                "type": "object",
                "properties": {
                  "defaults": {
                    "type": "array",
                    "items": {
                      "description": "The id for an option that is selected by default",
                      "type": "string"
                    }
                  },
                  "free_choices": {
                    "description": "The number of options that can be selected without incurring additional charges",
                    "type": "number"
                  },
                  "maximum_choices": {
                    "description": "The maximum number of options from the option group that may be selected",
                    "type": "number"
                  },
                  "maximum_unique_options": {
                    "description": "The maximum number of unique options from the option group that may be selected",
                    "type": "number"
                  },
                  "minimum_choices": {
                    "description": "The minimum number of options from the option group that may be selected",
                    "type": "number"
                  },
                  "minimum_unique_options": {
                    "description": "The minimum number of unique options from the option group that may be selected",
                    "type": "number"
                  },
                  "name": {
                    "description": "The name of the option group (e.g. Size)",
                    "type": "string"
                  },
                  "options": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "option": {
                          "description": "A possible option to be applied to a menu item",
                          "type": "object",
                          "properties": {
                            "maximum_quantity": {
                              "description": "The maximum number of the option that may be selected. Note that the minimum quantity is always assumed to be zero",
                              "type": "number"
                            },
                            "default_quantity": {
                              "description": "The default quantity of the option. Defaults to one. Only applicable when a maximum_quantity is given.",
                              "type": "number"
                            },
                            "name": {
                              "description": "The name of the option (e.g. 16oz)",
                              "type": "string"
                            },
                            "option_groups": {
                              "type": "array",
                              "items": {
                                "description": "The id for a parent option",
                                "type": "string"
                              }
                            },
                            "price": {
                              "description": "The cost of adding the option in cents",
                              "type": "number"
                            },
                            "provider_id": {
                              "description": "A unique ID (or XPath selector) for this element",
                              "type": "string"
                            },
                            "timescopes": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "title": "timescope",
                                "properties": {
                                  "time_of_day_starts_at": {
                                    "type": "string"
                                  },
                                  "time_of_day_ends_at": {
                                    "type": "string"
                                  },
                                  "day_of_week_starts_at": {
                                    "type": "string"
                                  },
                                  "day_of_week_ends_at": {
                                    "type": "string"
                                  },
                                  "date_starts_at": {
                                    "type": "string"
                                  },
                                  "date_ends_at": {
                                    "type": "string"
                                  }
                                },
                                "dependencies": {
                                  "time_of_day_ends_at": [
                                    "time_of_day_starts_at"
                                  ],
                                  "time_of_day_starts_at": [
                                    "time_of_day_ends_at"
                                  ],
                                  "day_of_week_ends_at": [
                                    "day_of_week_starts_at"
                                  ],
                                  "day_of_week_starts_at": [
                                    "day_of_week_ends_at"
                                  ],
                                  "date_ends_at": [
                                    "date_starts_at"
                                  ],
                                  "date_starts_at": [
                                    "date_ends_at"
                                  ]
                                }
                              }
                            }
                          },
                          "required": [
                            "name",
                            "price",
                            "provider_id"
                          ]
                        }
                      }
                    }
                  },
                  "provider_id": {
                    "description": "A unique ID (or XPath selector) for this option group",
                    "type": "string"
                  },
                  "timescopes": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "title": "timescope",
                      "properties": {
                        "time_of_day_starts_at": {
                          "type": "string"
                        },
                        "time_of_day_ends_at": {
                          "type": "string"
                        },
                        "day_of_week_starts_at": {
                          "type": "string"
                        },
                        "day_of_week_ends_at": {
                          "type": "string"
                        },
                        "date_starts_at": {
                          "type": "string"
                        },
                        "date_ends_at": {
                          "type": "string"
                        }
                      },
                      "dependencies": {
                        "time_of_day_ends_at": [
                          "time_of_day_starts_at"
                        ],
                        "time_of_day_starts_at": [
                          "time_of_day_ends_at"
                        ],
                        "day_of_week_ends_at": [
                          "day_of_week_starts_at"
                        ],
                        "day_of_week_starts_at": [
                          "day_of_week_ends_at"
                        ],
                        "date_ends_at": [
                          "date_starts_at"
                        ],
                        "date_starts_at": [
                          "date_ends_at"
                        ]
                      }
                    }
                  },
                  "required": [
                    "name",
                    "options",
                    "provider_id"
                  ]
                }
              }
            },
            "required": [
              "option_group"
            ]

          }
        }
      },
      "required": [
        "allows_special_instructions",
        "categories",
        "name",
        "option_groups",
        "provider_id",
        "updated_at"
      ]
    }
  }
}

Our core menu format is comprised of the following entities:

  • General Information: LevelUp requires some top-level information about menus such as whether or not special instructions are allowed on orders and a name for the menu.

  • Categories: A category is a collection of items. I.E. a category like “Smoothies” might contain the following items: “Banana Smoothie”, “Strawberry Coolatta” and “Raspberry Fusion”. All menus have categories. Categories never have a price. Categories may have an optional attribute of a category group.

  • Category Groups: A category group is a collection into which a category fits. I.E. the following categories “Soft Drinks”, “Smoothies” and “Fresh Juices” might all have a category group of “Beverages”. Not all menus have category groups. If a category does not belong to a category group, simply don’t include a category group attribute under the category. Category groups never have a price. If some categories are under a category group and others are not, only fill out the category group attribute for those that have it.

  • Items: An item is a specific thing on a menu, that is included in categories and can have zero, one or many option groups. In the category “Smoothies”, one of the items might be “Banana Smoothie” and it might have options that allow for the customization of certain aspects of that item like “Size”, “Mix-Ins” or “Quantity”. Items always have prices, though the base price of an item might be $0 if the cost is derived entirely from its options. Items either allow for special instructions or don’t. Special instructions can have an optional character limit – if none is available, set the attribute value to nil and LevelUp defaults to 120. You may include images for items, as well as nutrition information if available. You may include optional metadata along with each item that can be passed back to you during order validation and submission. Any metadata key that begins with “integration-” will be passed back in this way. All other keys will be ignored.

  • Option Groups: An option group is a collection of options. Option groups always have a parent entity, that is either an item, or an option in another option group. For example, “Size” would be an option group with a parent that is simply the item “Banana Smoothie” and it contains options underneath it such as “8 oz”, “12 oz” and “16 oz”. Let’s say that if the user selected 16 oz, they also got to pick their cup’s design. That would be yet another option group, this time with a parent being the 16 oz option. I.E. “Cup Design” would be an option group, with a parent entity of “16 oz” and with options of “Toy Story Themed”, “Superman Themed” or “Star Wars Themed”. Option groups never have a price themselves, only the options have a price. Each option group also has validations that need to be gathered from the menu, i.e. “Select only 1” or “Pick at least 3.” or “Pick As Many As You Want, First One Free”, or “Pick at most 3 unique options”. The format for these requirements is described in LevelUp’s JSON menu structure.

  • Nested Options: Please note that LevelUp will return options in a “flattened” fashion in our order validation and order submission requests. So if you believe that a given item will require that options be presented in a nested fashion, you will need to encode that nesting logic into your option ids, using some delimiter such as “:” or “-”. I.E. parentoptiongroup:option_id so that you can parse it back out as needed. You can also include optional metadata along with each item, which can contain the appropriate nesting which we will echo back to you.

  • Options: Options are the items contained within option groups. For example, the options in the option group “Size” would be “8 oz”, “12 oz” and “16 oz”. Options can be the parents of other option groups. Options always have a price, even if that price is $0. When a user is able to select multiple of an option, that option can have a maximum_quantity that indicates the maximum number of that option the user can select. For example, for Dunkin Donuts coffee, the user can elect to add sweetener as an option, and then input the quantity that they want. Additionally, options can also have a default_quantity. For example, when sweetener is added to a medium Dunkin Donuts it comes default with (3) sweetener. When a default_quantity is not given, it will be assumed to be (1). Options have may nutrition information associated with them.

Additional description of certain attributes:

  • Nutrition: This property is optional but should be included whenever possible.

  • Menu Name: You can title your menu name as “Merchant_Name [Provider_Name]”. I.E. “Joe’s Coffee Shop [Revel]”.

  • Timescopes: This is a list of Timescope objects that are applied to the parent menu object. Timescopes are optional, and should not be provided or Nil if the menu object is always available, or if a Timescope is not determinable. See the “Timescopes and Partially Available Items” sub-section below for a more in-depth description of a Timescope object.

  • Defaults: Defaults should be passed back along with any option_group to let us know which are the options defaulted to true (i.e. preselected) on a given item. LevelUp will display these within our mobile UI as pre-checked and, assuming the user does not uncheck them, echo them back as normally selected options in the validate/submit call.

  • Other Notes:

    • IDs should, whenever possible, be persistent across menu refreshes.
    • IDs generally only need to be unique enough for you to be able to find the item again, since LevelUp returns item and options with their parent ids (such as categories, category groups or option_groups for options) included in the post. However, we do flatten all options under the top-level item, so if IDs for options are shared within the same item, you will have to make them unique for us.
    • If a category involves catering option, please always leave it out, unless explicitly requested by the merchant to include it within LevelUp. We don’t by default include any catering options.
    • Please be sure to return the categories, items, option groups, options in the order they are listed on the underlying menu. The sequence of things on a menu is something a merchant tends to put a lot of thought into to design it to be best suited for consumer habits. We want to make sure to respect/replicate that.
    • If special instructions are false, character count should be set to nil.
    • If Option groups have two sets of validations, namely minimum_choices/maximum_choices and minimum_unique_options/maximum_unique_options. The former is validated against the total quantity across all options a user selects, with each option defaulting to a quantity of (1). The latter is validated against the unique set of options a user selects for that option group, disregarding option quantities. For example, if for the option group “Select your bagels” a user selects 3x Plain and 3x Blueberry, their choices would be (6) and unique_options (2).

Timescopes and Partially Available Items: A Timescope object is used to specify when a menu object is available on the menu and can be ordered. The following menu objects support Timescopes: Categories, category groups, items, options and option groups.

A single object is composed of 3 sets of fields:

  • time_of_day_[starts|ends]_at - String in ISO 8601 Format (h:mm or hh:mm only, do not provide timezone information we assume the implied timezone is specific to that location) representing the hour and minute of a day the item is available. All times should be in the same timezone as the restaurant location. Set to null if available all day.

  • day_of_week_[starts|ends]_at - String (values: “Monday” through “Sunday” only, without the quotes) representing the days of the week, that the item is available. Set to null if available all week. date[starts|ends]at - String in ISO 8601 Format (YYYY-MM-DD only) representing the calendar date range that the item is available, inclusive. Set to null if unknown/available all year.

Each set is optional. For example, you can specify time_of_day_starts_at and time_of_day_ends_at without specifying the other sets to indicate the item is available during a certain period of the day, every day of the week, all year.

In the menu JSON each menu object can have a list of Timescope objects associated with it (this list is named “timescopes”). The list format is used to allow multiple availability periods (e.g. Mon 9-11 AM, Wed 9-11AM and Fri 9-11AM) to be specified for a specific object.

Example Timescopes list specifying that a particular breakfast sandwich is only available from 9-1130am on Mon, Wed, Fri:

"timescopes": [
  {
    "time_of_day_ends_at" : "11:30",
    "time_of_day_starts_at" : "9:00",
    "day_of_week_ends_at" : "Monday",
    "day_of_week_starts_at" : "Monday",
    "date_ends_at" : null,
    "date_starts_at" : null
  },
  {
    "time_of_day_ends_at" : "11:30",
    "time_of_day_starts_at" : "9:00",
    "day_of_week_ends_at" : "Wednesday",
    "day_of_week_starts_at" : "Wednesday",
    "date_ends_at" : null,
    "date_starts_at" : null
  },
  {
    "time_of_day_ends_at" : "11:30",
    "time_of_day_starts_at" : "9:00",
    "day_of_week_ends_at" : "Friday",
    "day_of_week_starts_at" : "Friday",
    "date_ends_at" : null,
    "date_starts_at" : null
  }
]