Example Objects
Example Menu
This is an example JSON Menu Object that can be uploaded to the Create Menu Configuration endpoint.
Example Menu Object
1 { 2 "menus": [ 3 { 4 "external_id": "main_menu", 5 "name": { 6 "translations": { 7 "en": "Main Menu", 8 "es_es": "Menú Principal" 9 } 10 }, 11 "availability": [ 12 { 13 "day_of_week": "MON", 14 "time_periods": [ 15 { 16 "start_time": "11:00", 17 "end_time": "22:00" 18 } 19 ] 20 }, 21 { 22 "day_of_week": "TUE", 23 "time_periods": [ 24 { 25 "start_time": "11:00", 26 "end_time": "22:00" 27 } 28 ] 29 }, 30 { 31 "day_of_week": "WED", 32 "time_periods": [ 33 { 34 "start_time": "11:00", 35 "end_time": "22:00" 36 } 37 ] 38 }, 39 { 40 "day_of_week": "THU", 41 "time_periods": [ 42 { 43 "start_time": "11:00", 44 "end_time": "22:00" 45 } 46 ] 47 }, 48 { 49 "day_of_week": "FRI", 50 "time_periods": [ 51 { 52 "start_time": "11:00", 53 "end_time": "23:00" 54 } 55 ] 56 }, 57 { 58 "day_of_week": "SAT", 59 "time_periods": [ 60 { 61 "start_time": "11:00", 62 "end_time": "23:00" 63 } 64 ] 65 }, 66 { 67 "day_of_week": "SUN", 68 "time_periods": [ 69 { 70 "start_time": "12:00", 71 "end_time": "21:00" 72 } 73 ] 74 } 75 ], 76 "category_external_ids": [ 77 "appetizers", 78 "main_courses", 79 "desserts", 80 "drinks" 81 ] 82 } 83 ], 84 "categories": [ 85 { 86 "external_id": "appetizers", 87 "name": { 88 "translations": { 89 "en": "Appetizers", 90 "es_es": "Aperitivos" 91 } 92 }, 93 "description": { 94 "translations": { 95 "en": "Start your meal with these delicious appetizers", 96 "es_es": "Comience su comida con estos deliciosos aperitivos" 97 } 98 }, 99 "item_external_ids": [ 100 "nachos" 101 ] 102 }, 103 { 104 "external_id": "main_courses", 105 "name": { 106 "translations": { 107 "en": "Main Courses", 108 "es_es": "Platos Principales" 109 } 110 }, 111 "description": { 112 "translations": { 113 "en": "Satisfy your hunger with our main courses", 114 "es_es": "Satisfaga su hambre con nuestros platos principales" 115 } 116 }, 117 "item_external_ids": [ 118 "burger" 119 ] 120 }, 121 { 122 "external_id": "desserts", 123 "name": { 124 "translations": { 125 "en": "Desserts", 126 "es_es": "Postres" 127 } 128 }, 129 "description": { 130 "translations": { 131 "en": "Finish your meal with something sweet", 132 "es_es": "Termine su comida con algo dulce" 133 } 134 } 135 }, 136 { 137 "external_id": "drinks", 138 "name": { 139 "translations": { 140 "en": "Drinks", 141 "es_es": "Bebidas" 142 } 143 }, 144 "description": { 145 "translations": { 146 "en": "Quench your thirst with our selection of drinks", 147 "es_es": "Sacie su sed con nuestra selección de bebidas" 148 } 149 }, 150 "item_external_ids": [ 151 "soda", 152 "beer" 153 ] 154 } 155 ], 156 "items": [ 157 { 158 "external_id": "nachos", 159 "name": { 160 "translations": { 161 "en": "Nachos", 162 "es_es": "Nachos" 163 } 164 }, 165 "in_stock": "false", 166 "description": { 167 "translations": { 168 "en": "Crispy tortilla chips with melted cheese and toppings", 169 "es_es": "Crujientes chips de tortilla con queso fundido y coberturas" 170 } 171 }, 172 "price": 899, 173 "tax": 72, 174 "ingredients": "Tortilla chips, cheese, jalapeños, sour cream, guacamole", 175 "allergens": "Milk, Wheat", 176 "dietary_labels": [ 177 "VEGETARIAN" 178 ], 179 "prep_time": 10, 180 "sell_separately": True, 181 "modifier_external_ids": [ 182 "nacho_toppings" 183 ] 184 }, 185 { 186 "external_id": "burger", 187 "name": { 188 "translations": { 189 "en": "Classic Burger", 190 "es_es": "Hamburguesa Clásica" 191 } 192 }, 193 "description": { 194 "translations": { 195 "en": "Juicy beef patty with lettuce, tomato, and cheese", 196 "es_es": "Jugosa hamburguesa de res con lechuga, tomate y queso" 197 } 198 }, 199 "price": 1299, 200 "tax": 104, 201 "ingredients": "Beef patty, bun, lettuce, tomato, cheese, pickles", 202 "allergens": "Milk, Wheat, Soy", 203 "prep_time": 15, 204 "sell_separately": True, 205 "modifier_external_ids": [ 206 "burger_toppings" 207 ] 208 }, 209 { 210 "external_id": "soda", 211 "name": { 212 "translations": { 213 "en": "Soda", 214 "es_es": "Refresco" 215 } 216 }, 217 "description": { 218 "translations": { 219 "en": "Refreshing carbonated drink", 220 "es_es": "Refrescante bebida carbonatada" 221 } 222 }, 223 "price": 299, 224 "tax": 24, 225 "sell_separately": True, 226 "modifier_external_ids": [ 227 "soda_size" 228 ] 229 }, 230 { 231 "external_id": "beer", 232 "name": { 233 "translations": { 234 "en": "Beer", 235 "es_es": "Cerveza" 236 } 237 }, 238 "description": { 239 "translations": { 240 "en": "Cold, refreshing beer", 241 "es_es": "Cerveza fría y refrescante" 242 } 243 }, 244 "price": 599, 245 "tax": 48, 246 "allergens": "Barley", 247 "alcohol_by_volume": 5.0, 248 "sell_separately": True, 249 "modifier_external_ids": [ 250 "beer_type" 251 ] 252 } 253 ], 254 "modifier_groups": [ 255 { 256 "external_id": "nacho_toppings", 257 "type": "MULTIPLE", 258 "name": { 259 "translations": { 260 "en": "Nacho Toppings", 261 "es_es": "Coberturas de Nachos" 262 } 263 }, 264 "group_max": 5, 265 "group_min": 0, 266 "charge_after": 2, 267 "modifier_item_external_ids": [ 268 "extra_cheese", 269 "extra_guacamole" 270 ] 271 }, 272 { 273 "external_id": "burger_toppings", 274 "type": "MULTIPLE", 275 "name": { 276 "translations": { 277 "en": "Burger Toppings", 278 "es_es": "Coberturas de Hamburguesa" 279 } 280 }, 281 "group_max": 4, 282 "group_min": 0, 283 "charge_after": 1, 284 "modifier_item_external_ids": [ 285 "extra_cheese", 286 "bacon" 287 ] 288 }, 289 { 290 "external_id": "soda_size", 291 "type": "SINGLE", 292 "name": { 293 "translations": { 294 "en": "Soda Size", 295 "es_es": "Tamaño de Refresco" 296 } 297 }, 298 "group_max": 1, 299 "group_min": 1, 300 "charge_after": 0, 301 "modifier_item_external_ids": [ 302 "small_soda", 303 "large_soda" 304 ] 305 }, 306 { 307 "external_id": "beer_type", 308 "type": "SINGLE", 309 "name": { 310 "translations": { 311 "en": "Beer Type", 312 "es_es": "Tipo de Cerveza" 313 } 314 }, 315 "group_max": 1, 316 "group_min": 1, 317 "charge_after": 0, 318 "modifier_item_external_ids": [ 319 "lager", 320 "ale" 321 ] 322 } 323 ], 324 "modifier_items": [ 325 { 326 "external_id": "extra_cheese", 327 "name": { 328 "translations": { 329 "en": "Extra Cheese", 330 "es_es": "Queso Extra" 331 } 332 }, 333 "price_change": 100, 334 "tax_change": 8, 335 "min_quantity": 0, 336 "max_quantity": 1, 337 "default_quantity": 0 338 }, 339 { 340 "external_id": "extra_guacamole", 341 "name": { 342 "translations": { 343 "en": "Extra Guacamole", 344 "es_es": "Guacamole Extra" 345 } 346 }, 347 "price_change": 150, 348 "tax_change": 12, 349 "min_quantity": 0, 350 "max_quantity": 1, 351 "default_quantity": 0 352 }, 353 { 354 "external_id": "bacon", 355 "name": { 356 "translations": { 357 "en": "Bacon", 358 "es_es": "Tocino" 359 } 360 }, 361 "price_change": 200, 362 "tax_change": 16, 363 "min_quantity": 0, 364 "max_quantity": 2, 365 "default_quantity": 0 366 }, 367 { 368 "external_id": "small_soda", 369 "name": { 370 "translations": { 371 "en": "Small", 372 "es_es": "Pequeño" 373 } 374 }, 375 "price_change": 0, 376 "tax_change": 0, 377 "min_quantity": 0, 378 "max_quantity": 1, 379 "default_quantity": 1 380 }, 381 { 382 "external_id": "large_soda", 383 "name": { 384 "translations": { 385 "en": "Large", 386 "es_es": "Grande" 387 } 388 }, 389 "price_change": 100, 390 "tax_change": 8, 391 "min_quantity": 0, 392 "max_quantity": 1, 393 "default_quantity": 0 394 }, 395 { 396 "external_id": "lager", 397 "name": { 398 "translations": { 399 "en": "Lager", 400 "es_es": "Lager" 401 } 402 }, 403 "price_change": 0, 404 "tax_change": 0, 405 "min_quantity": 0, 406 "max_quantity": 1, 407 "default_quantity": 1 408 }, 409 { 410 "external_id": "ale", 411 "name": { 412 "translations": { 413 "en": "Ale", 414 "es_es": "Ale" 415 } 416 }, 417 "price_change": 100, 418 "tax_change": 8, 419 "min_quantity": 0, 420 "max_quantity": 1, 421 "default_quantity": 0 422 } 423 ] 424 }
