Returns an entire menu

get https://qa2.revelup.com/weborders/menu/

Return an entire menu, including the Categories, Products and Modifiers, in a single call

Responses

Response body

object

status

string

Response status

data

object

categories

object

sort

int64

Numerical value that represents the sorting order for the resources displayed in the UI. Lower values appear higher on the list.

parent_name

string

Parent category name

timetables

array of arrays of objects

List of category timetables

timetables

array of objects

object

active

int32

from_date

date-time

ISO 8601 timestamp of the timetable active from.

timetable_data

object

Days from monday to sunday with time to/from, if day has no time available, that day will not be present.

type

int32

Custome menu mode type.

to_date

date-time

ISO 8601 timestamp of the timetable active to.

name

string

Name of product category

parent_id

int64

Id of parent category

parent_sort

int64

Numerical value that represents parent sorting order

image

uri

Image of product category (if exists, otherwise null)

int64

description

string

Product category description (if exists, otherwise null)

products

array of objects

products

object

timetables

array of objects

Timetable data of a product.

timetables

object

active

int32

from_date

date-time

ISO 8601 timestamp of the timetable active from.

timetable_data

object

Days from monday to sunday with time to/from, if day has no time available, that day will not be present.

type

int32

Custome menu mode type.

to_date

date-time

ISO 8601 timestamp of the timetable active to.

modifier_classes

array of objects

modifier_classes

object

active

boolean

Defaults to true

admin_mod_key

string

length ≤ 10

Internal code used for defining is modifier admin modifier. If applied, it will force rules for that modifier, and will work if admin_modifier is set to true.

admin_modifier

boolean

Defaults to false

If true it means that this is one of 5 basic modifiers that are set up.

amount_free

int32

Amount of modifiers by quantity or price that can be selected for free

amount_free_is_dollars

boolean

If true amount_free is by price, if false - by quantity

int64

Id of the WebordersModifierClass object.

forced

boolean

Deprecated - if true, it means that minimum_amount is more than 0

name

string

length ≤ 80

Name of the WebordersModifierClass object.

maximum_amount

int32

Maximum amount of modifiers that can be selected

minimum_amount

int32

Minimum amount of modifiers that have to be selected

modifiers

array of objects

modifiers

object

active

boolean

Defaults to true

barcode

string

length ≤ 200

Alphanumeric barcode - can be used to find modifiers quickly. Must be unique in a given Establishment.

cost

float

Inventory cost of the modifier. Up to 4 decimal places supported. Maximum length is 16 characters.

int64

Id of the WebordersModifierItem object.

img_url

uri

Image for this modifier.

is_quick

boolean

If true this is a 'Quick' modifier

name

string

length ≤ 80

Name of the modifier.

price

float

Price of the modifier. Stores up to 14 decimal places.

selected

boolean

Whether modifier is selected.

default_modifier_qty

integer

0 to 99

Quantity for default modifier. If set to 0 modifier will not be considered as default

maximum_modifier_qty

integer

0 to 99

Maximum quantity that a user may select per modifier. Not to exceed default modifier value or maximum modifiers per group. Blank value or quantity of 0 means no maximum.

sku

string

length ≤ 200

Modifier SKU - can be used to find modifiers quickly. Must be unique in a given Establishment. Allows letters, numbers, underscores, dots, dashes and commas.

sort

int64

Numerical value that represents the sorting order for the resources displayed in the UI. Lower values appear higher on the list.

modifier_class_id

int64

Id of the WebordersModifierClass object.

sort

int64

≥ 0

Numerical value that represents the sorting order for the resources displayed in the UI. Lower values appear higher on the list.

split

boolean

Defaults to false

If checked, any modifier assigned to this class are eligible to be split(by global setting). If unchecked, this class of modifiers will not be split-eligable.

400

Invalid Establishment ID

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://qa2.revelup.com/weborders/menu/ \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Application modes:

200Succesfully retrieved an entire menu