Get Menus

post
Get Menu List

[PlatformAddress]/api/1.0/venue?action=getMenuList
Get a list of menus.
Request
Response
Request
Path Parameters
venueId
required
integer
The id of the venue
perPage
optional
integer
The number of menu to get in a single call
Response
200: OK
{
"meta": {
"totalResults": 5,
"start": 0,
"perPage": 50,
"count": 2
},
"results": [
{
"id": 125,
"name": "Menu 1",
"minimumPax": 20,
"maximumPax": 30,
"cost": 98,
"costType": 1,
"smallDescription": "small description",
"marketplaceName": "Marketplace Name 1",
"marketplaceEventTypes": null
},
{
"id": 125,
"name": "Menu 2",
"minimumPax": 10,
"maximumPax": 30,
"cost": 198,
"costType": 2,
"smallDescription": "small description",
"marketplaceName": "Marketplace Name 2",
"marketplaceEventTypes": null
}
]
}

The result from this call will be a collection of all the menus the user has access to. This call also accepts the pagination and filter properties.

Example Request

Get a specific menu List

{
"venueId": "1",
"perPage": "50",
}

Menu

Property

Type

Description

id

integer

The unique id of the menu

name

text

The name of the menu

minimumPax

integer

The minimum number of people allowed within a single session to order this menu

maximumPax

integer

The maximum number of people allowed within a single session to order this menu

cost

integer

The price of the menu

costType

integer Cost Type‚Äč

The price type of the menu

smallDescription

text

The small description of the menu

marketplaceName

text

The name of the menu displayed in marketplace booking engines

marketplaceEventTypes

text

The event types of the menu displayed in marketplace booking engines

Cost Type (menu pricing)

One of the following values:

  • 1 = Per person

  • 2 = Flat rate