Upload Menu

post

https://order_platform_url/menus

The Upload Menu endpoint is designed to allow external food aggregators, online ordering platforms, etc... to recieve a new menu or existing menu updates for stores. This functionality is essential for keeping store menus up to date, including items, categories, prices, and availability. When a call is made to this endpoint, the entire menu for a specific store or stores should be overwritten with the new menu data provided in the request, replacing any existing menu configurations.

The menu payload has the following structure. alt text

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

string

required

Unique identifier for the menu, provided by GrubTech.

name

object

required

Provides content for a string displayed to users in multiple languages.

description

object

Provides content for a string displayed to users in multiple languages.

imageUrl

string

required

URL pointing to an image of the item.
Image Specifications:
- File size less than 2MB.
- Image format in JPEG, PNG.
- Resolution for the images will be 800 x 800 px.

currencyCode

string

required

Applicable currency code for the menu. According to ISO-4217

storeIds

array of strings

required

Unique identifiers for each location for which the menu should be updated.

storeIds*

externalData

string

(optional) Free-form text field reserved for the api consumer to use, e.g. for POS integrations

items

array of objects

required

List of items belongs to the store. This list contains both menu items and modifiers

items*

modifierGroups

array of objects

required

List of modifier groups belongs to the store

modifierGroups*

200Successful response OK

400Bad request

500Internal server error