Menu

Menu interactions provide detailed insights into the composition of the menu, its products, and its modifiers through nested data structures.

diagram_menu_1

1 - Get Master Menu

A simple request will retrieve the master Menu with all menu items, categories, modifiers, and combos.

Request
Definitions Example 

{
    "requestType": String,
    "actionType": String,
}
            

{
    "requestType": "menu",
    "actionType": "getMaster",
}

See definitions

Response
Definitions Example 

{
    "status": String,
    "menu": Object,
}
            

{
    "status": "OK",
    "menu": {
        "menu": {},
        "type": "MENU",
        "id": "53042",
        "department": {},
        "modifier_component": {},
        "modifier_template": {},
        "priority": 1,
        "modified": "1718119945",
        "created": "1684343083",
        "combo": {},
        "combo_template": {},
        "name": "KC-TEST",
        "lock_id": "0",
        "deleted": 0
    }
}

See definitions

2 - Get Menu By Number

Retrieve a specific menu configuration by its menu number (1-4). Restaurants can have multiple menu configurations for different time periods or locations.

Request
Definitions Example 

{
    "requestType": String,
    "actionType": String,
    "menuNumber": Number
}
            

{
    "requestType": "menu",
    "actionType": "getByNumber",
    "menuNumber": 1
}

See definitions

Response
Definitions Example 

{
    "status": String,
    "menu": Object
}
            

{
    "status": "OK",
    "menu": {
        "menu": {},
        "type": "MENU",
        "id": "53042",
        "department": {},
        "modifier_component": {},
        "modifier_template": {},
        "priority": 1,
        "modified": "1718119945",
        "created": "1684343083",
        "combo": {},
        "combo_template": {},
        "name": "LUNCH MENU",
        "lock_id": "0",
        "deleted": 0
    }
}

See definitions

Definitions

Request Definitions

Definition Type Description
requestType String (["menu"]) Unique request identifier.
actionType String (["getMaster", "getByNumber"]) Unique action identifier for your request.
menuNumber Number ([1, 2, 3, 4]) The menu number to retrieve (1-4). Used with getByNumber action.

Response Definitions

Definition Type Description
status String (["OK", "ERROR"]) Request status.
menu Object[] The menu data. See more