Waiting list

Requests related to Waiting (Waiting list) allows you to manage a virtual waiting list and organize the guests that aren’t assigned to a table yet.

A diagram that explains the flow of first 4 subtitles

1 - Add a guest to the Waiting list

When a guest arrives and all tables are already assigned, you can add them to the waiting list.

"A guest comes to your restaurant entrance and wants to order something. All the tables are already assigned, so let’s put him on the waiting list."

Request
Definitions Example 

{
    "requestType": String,
    "actionType": String,
    "waiting": {
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": String[],
        "memo": String,
        "quoted": Number
    }
}
            

{
    "requestType": "waiting",
    "actionType": "add",
    "waiting": {
        "phone": "1234567890",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE",
        "option": ["BIRTHDAY"],
        "memo": "16th birthday",
        "quoted": 1720658880
    }
}

See definitions

Response
Definitions Example 

{
    "status": String,
    "waiting": {
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": [
            String
        ],
        "memo": String,
        "id": String,
        "created": Number,
        "number": Number,
        "terminal_number": String,
        "user_id": String,
        "user_name": String,
        "modified": Number,
        "modified_human": String
    }
}
            

{
    "status": "OK",
    "waiting": {
        "phone": "1234567890",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE",
        "option": [
            "BIRTHDAY"
        ],
        "memo": "16th birthday",
        "id": "2328a2a313b305f30dcfe15d23e582d9",
        "created": 1721005397,
        "number": 1,
        "terminal_number": "3",
        "user_id": "4",
        "user_name": "GM",
        "modified": 1721005397,
        "modified_human": "07/14/2024 10:03:17 PM"
    }
}

See definitions

2 – Update guest data

"If new information arises, such as a guest's birthday or a change in party size, you can update the waiting list "

Request
Definitions Example 

{
    "requestType": String,
    "actionType": String,
    "waiting": {
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": String[],
        "memo": String,
        "quoted": Number,
        "id": String
    }
}
            

{
    "requestType": "waiting",
    "actionType": "update",
    "waiting": {
        "phone": "1234567890",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE 2",
        "option": ["BIRTHDAY2"],
        "memo": "18th birthday",
        "quoted": 1720658880,
        "id": "7d08055508bef40af08aa40579ac672f"
    }
}

See definitions

Response
Definitions Example 

{
    "status": String,
    "waiting": {
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": String[],
        "memo": String,
        "quoted": Number,
        "id": String,
        "created": Number,
        "number": Number,
        "terminal_number": String,
        "user_id": String,
        "user_name": String,
        "modified": Number,
        "modified_human": String
    }
}
            

{
    "status": "OK",
    "waiting": {
        "phone": "123456789",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE",
        "option": ["BIRTHDAY"],
        "memo": "18th birthday",
        "quoted": 1720658880,
        "id": "7d08055508bef40af08aa40579ac672f",
        "created": 1721005458,
        "number": 2,
        "terminal_number": "3",
        "user_id": "4",
        "user_name": "GM",
        "modified": 1721005458,
        "modified_human": "07/14/2024 10:04:18 PM"
    }
}

See definitions

3 – Notify the guest

"Once a table becomes available, you can let the guests know"

Request
Definitions Example 

{
    "status": String,
    "waiting": {
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": String[],
        "memo": String,
        "quoted": Number,
        "id": String,
        "created": Number,
        "number": Number,
        "terminal_number": String,
        "user_id": String,
        "user_name": String,
        "modified": Number,
        "modified_human": String
    }
}
            

{
    "status": "active",
    "waiting": {
        "phone": "1234567890",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE",
        "option": ["BIRTHDAY"],
        "memo": "18th birthday",
        "quoted": 1720658880,
        "id": "7d08055508bef40af08aa40579ac672f",
        "created": 1720658880,
        "number": 5,
        "terminal_number": "T123",
        "user_id": "u123",
        "user_name": "Jane Smith",
        "modified": 1720658880,
        "modified_human": "2023-10-10T10:00:00Z"
    }
}
Response
Definitions Example 

{
    "status": String,
    "waiting": {
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": [
            String
        ],
        "memo": String,
        "quoted": Number,
        "id": String,
        "log": [{
            "type": String,
            "timestamp": Number
        }],
        "created": Number,
        "number": Number,
        "terminal_number": String,
        "user_id": String,
        "user_name": String,
        "modified": Number,
        "modified_human": String
    }
}
            

{
    "status": "OK",
    "waiting": {
        "phone": "1234567890",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE",
        "option": [
            "BIRTHDAY"
        ],
        "memo": "18th birthday",
        "quoted": 1720658880,
        "id": "7d08055508bef40af08aa40579ac672f",
        "log": [{
            "type": "NOTIFY",
            "timestamp": 1721005554
        }],
        "created": 1721005458,
        "number": 2,
        "terminal_number": "3",
        "user_id": "4",
        "user_name": "GM",
        "modified": 1721005554,
        "modified_human": "07/14/2024 10:05:54 PM"
    }
}

See definitions

4 – Assign a table for the guest

After notifying them, you can seat the guests at the table.

Request
Definitions Example 

{
    "requestType": String,
    "actionType": String,
    "tableNumber": Number,
    "waiting": {
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": String[],
        "memo": String,
        "quoted": Number,
        "id": String
    }
}
            

{
    "requestType": "waiting",
    "actionType": "sit",
    "tableNumber": 4,
    "waiting": {
        "phone": "1234567890",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE",
        "option": ["BIRTHDAY"],
        "memo": "18th birthday",
        "quoted": 1720658880,
        "id": "7d08055508bef40af08aa40579ac672f"
    }
}

See definitions

Response
Definitions Example 

{
    "status": String,
    "waiting": {
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": [
            String
        ],
        "memo": String,
        "quoted": Number,
        "id": String
    }
}
            

{
    "status": "OK",
    "waiting": {
        "phone": "1234567890",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE",
        "option": [
            "BIRTHDAY"
        ],
        "memo": "18th birthday",
        "quoted": 1720658880,
        "id": "7d08055508bef40af08aa40579ac672f"
    }
}

See definitions

A diagram that explains how to remove and restore a guest from the waiting list

5 - Remove a guest from the Waiting list

If a guest arrives but all tables are assigned, they can be added to the waiting list. If a guest no longer needs the table, they can be removed from the waiting list.

Request
Definitions Example 

{
    "requestType": String,
    "actionType": String,
    "waiting": {
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": String[],
        "memo": String,
        "quoted": Number,
        "id": String
    }
}
            

{
    "requestType": "waiting",
    "actionType": "cancel",
    "waiting": {
        "phone": "1234567890",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE",
        "option": ["BIRTHDAY"],
        "memo": "18th birthday",
        "quoted": 1720658880,
        "id": "15cc4a9652f140c9d547733598c7a112"
    }
}

See definitions

Response
Definitions Example 

{
    "status": String,
    "waiting": {
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": String[],
        "memo": String,
        "quoted": Number,
        "id": String
    }
}
            

{
    "status": "OK",
    "waiting": {
        "phone": "1234567890",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE",
        "option": ["BIRTHDAY"],
        "memo": "18th birthday",
        "quoted": 1720658880,
        "id": "15cc4a9652f140c9d547733598c7a112"
    }
}

See definitions

6 - Restore a guest to the Waiting list

"If a guest returns and still needs the table, we’ve already entered his data, so there’s no need to add him to the Waiting List from scratch. You can restore their information from the canceled li."

Request
Definitions Example 

{
    "requestType": String,
    "actionType": String,
    "waiting": {
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": String[],
        "memo": String,
        "quoted": Number,
        "id": String
    }
}
            

{
    "requestType": "waiting",
    "actionType": "restore",
    "waiting": {
        "phone": "1234567890",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE",
        "option": ["BIRTHDAY"],
        "memo": "18th birthday",
        "quoted": 1720658880,
        "id": "7d08055508bef40af08aa40579ac672f"
    }
}

See definitions

Response
Definitions Example 

{
    "status": String,
    "waiting": {
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": String[],
        "memo": String,
        "quoted": Number,
        "id": String
    }
}
            

{
    "status": "OK",
    "waiting": {
        "phone": "1234567890",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE",
        "option": ["BIRTHDAY"],
        "memo": "18th birthday",
        "quoted": 1720658880,
        "id": "15cc4a9652f140c9d547733598c7a112"
    }
}

See definitions

A diagram to understand better what is a waiting list and an archived waiting list

7 – Get the Waiting list

With all this "coming and going", to ensure accuracy you can request the waiting list.

Request
Definitions Example 

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

{
    "requestType": "waiting",
    "actionType": "getList"
}

See definitions

Response
Definitions Example 

{
    "status": String,
    "waitingList": [{
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": String[],
        "memo": String,
        "quoted": Number,
        "id": String,
        "created": Number,
        "number": Number,
        "terminal_number": String,
        "user_id": String,
        "user_name": String,
        "modified": Number,
        "modified_human": String
    }]
}
            

{
    "status": "OK",
    "waitingList": [{
        "phone": "1234567890",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE",
        "option": ["BIRTHDAY"],
        "memo": "16th birthday",
        "quoted": 1720658880,
        "id": "2328a2a313b305f30dcfe15d23e582d9",
        "created": 1721005397,
        "number": 1,
        "terminal_number": "3",
        "user_id": "4",
        "user_name": "GM",
        "modified": 1721005397,
        "modified_human": "07/14/2024 10:03:17 PM"
    }]
}

See definitions

8 – Get the Archived Waiting list

If there is any mistake or unexpected behavior, you can always ask for an “archived” list.

Request
Definitions Example 

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

{
    "requestType": "waiting",
    "actionType": "getArchivedList"
}

See definitions

Response
Definitions Example 

{
    "status": String,
    "waitingArchivedList": [{
        "phone": String,
        "name": String,
        "size": Number,
        "location": String,
        "seat": String,
        "option": String[],
        "memo": String,
        "quoted": Number,
        "id": String,
        "log": [{
            "type": String,
            "timestamp": Number
        }],
        "created": Number,
        "number": Number,
        "terminal_number": String,
        "user_id": String,
        "user_name": String,
        "modified": Number,
        "modified_human": String,
        "status": String,
        "seated": Number,
        "waited": Number,
        "path": String
    }, {
        "count": Number,
        "terminal_number": String,
        "user_id": String,
        "user_name": String,
        "created": Number(timestamp),
        "created_human": String,
        "modified": Number(timestamp),
        "modified_human": String,
        "path": String
    }]
}
            

{
    "status": "OK",
    "waitingArchivedList": [{
        "phone": "1234567890",
        "name": "JOHN DOE",
        "size": 2,
        "location": "DINING",
        "seat": "TABLE",
        "option": ["BIRTHDAY"],
        "memo": "18th birthday",
        "quoted": 1720658880,
        "id": "7d08055508bef40af08aa40579ac672",
        "log": [{
            "type": "NOTIFY",
            "timestamp": 1721005554
        }],
        "created": 1721005458,
        "number": 2,
        "terminal_number": "3",
        "user_id": "4",
        "user_name": "GM",
        "modified": 1721005683,
        "modified_human": "07/14/2024 10:08:03 PM",
        "status": "SEATED",
        "seated": 1721005683,
        "waited": 4,
        "path": "C:\\CloudPOS_MAS281"
    }, {
        "count": 2,
        "terminal_number": "3",
        "user_id": "4",
        "user_name": "GM",
        "created": 1721005458,
        "created_human": "07/14/2024 10:04:18 PM",
        "modified": 1721005458,
        "modified_human": "07/14/2024 10:04:18 PM",
        "path": "C:\\CloudPOS_MAS281\\"
    }]
}

Definitions

Request Definitions

Definition Type Description
actionType String (["getList", "add", "update", "notify", "sit", "cancel", "getArchivedList", "restore"]) Unique identifier for your request.
phone String The customer's phone number for contact purposes.
name String The name of the customer added to the waiting list.
size Number The number of people in the party added to the waiting list.
location String The designated area within the restaurant where the party will be seated once their turn arrives.
seat String The specific table or area assigned to the party when they are seated.
option String[] A choice or preference made by the customer regarding their seating or waiting arrangements.
memo String A note or message providing additional information or special requests.
quoted Number(timestamp) Estimated wait time for the customer.
id String A unique identifier for the waiting list entry. (used in "sit" request)

Response Definitions

Definition Type Description
waitingArchivedList Object[] A list of previous waiting list entries that have been completed or archived.
phone String The customer's phone number for contact purposes related to the waiting list.
name String The name of the customer added to the waiting list.
size Number The number of people in the party added to the waiting list.
location String The designated area within the restaurant where the party will be seated once their turn arrives.
seat String The specific table or area assigned to the party when they are seated.
option String[] A choice or preference made by the customer regarding their seating or waiting arrangements.
created Number(timestamp) The timestamp indicating when the waiting list entry was added.
number Number A unique identifier for the waiting list entry, typically representing the order in which customers are queued.
terminal_number String The identifier for the terminal or device used to manage the waiting list.
user_id String A unique identifier for the staff member or user managing the waiting list entry.
user_name String The name of the staff member or user managing the waiting list entry.
modified Number(timestamp) The timestamp indicating when the waiting list entry was last updated.
modified_human String A human-readable version of the timestamp indicating when the waiting list entry was last updated, typically formatted for easy understanding.
memo String A note or message that provides additional information or special requests related to the waiting list entry.
quoted Number(timestamp) Estimated wait time for the customer.
id String A unique identifier for the waiting list entry used to assign customers to a specific table.
log Object[]
status String Request status.
seated Number(timestamp) A timestamp indicating when the customers from the waiting list were seated at their table.
waited Number The duration of time the customers spent on the waiting list before being seated.
path String The system path or location used to access the waiting list data or resources within the application.
count Number The total number of entries in the waiting list, indicating how many parties are currently waiting.
created_human String A human-readable format of the timestamp indicating when the waiting list entry was created, typically for easier understanding.