Special Definitions

This page contains detailed definitions of complex objects used throughout the Server API.

kdsBoxData

KDS (Kitchen Display System) box data containing complete order information including void items, ticket data, and metadata.

Used in: KDS API

Structure:

{
    "id": "11751233353162",
    "printerID": 3,
    "list": [{
        "item": {
            "menu_id": "1527077721022",
            "qty": 1,
            "id": "1751109763000",
            "subtotal": 3120,
            "modifier": {
                "list": [{
                    "id": "1448081043012",
                    "category_id": "1448081104019",
                    "modifier_id": "1448081098018",
                    "price": "0",
                    "name": "HONEY WHEAT",
                    "text": "Honey Wheat",
                    "action": "",
                    "qty": "1",
                    "subtotal": 0
                }],
                "price": "200"
            },
            "name": "Stack",
            "price": 1000,
            "seat": "1",
            "printerTable": ["", "YES", "YES"],
            "report_department": "MODIFIER",
            "report_product": "STACK"
        },
        "qty": -1
    }],
    "ticketData": {
        "tax": 110,
        "subtotal": 1040,
        "total": 1337,
        "balance": 1337,
        "status": "OPEN",
        "number": 1002,
        "table_number": 7,
        "table_name": "A1",
        "guest_count": 5,
        "destination": "DINE-IN",
        "customer": {
            "name": "KC",
            "phone": "1234567890"
        },
        "list_item": [...],
        "user_id": "1",
        "user_name": "GM3",
        "terminal_number": "1",
        "created": 1750960287,
        "modified": 1751159543
    },
    "terminal_number": "1",
    "user_id": "1",
    "user_name": "GM3",
    "created": 1751233359,
    "created_human": "06/29/2025 05:42:39 PM",
    "modified": 1751233359,
    "modified_human": "06/29/2025 05:42:39 PM"
}

Fields:

id (String) - Unique identifier for the KDS box (timestamp-based)
printerID (Number) - Printer/station ID this order is assigned to
list (Array) - Array of order item modifications (voids, changes) with item details and quantity adjustments
ticketData (Object) - Complete ticket/order information (see ticketData)
terminal_number (String) - Terminal where order was created
user_id (String) - User ID who created/modified the order
user_name (String) - User name who created/modified the order
created (Number) - Unix timestamp when created
created_human (String) - Human-readable creation date/time
modified (Number) - Unix timestamp when last modified
modified_human (String) - Human-readable modification date/time

ticketData / ticket

Complete ticket/order information including totals, items, table info, customer details, and timestamps.

Used in: KDS API, Ticket API, Table API

Structure:

{
    "tax": 110,
    "subtotal": 1040,
    "total": 1337,
    "balance": 1337,
    "status": "OPEN",
    "number": 1002,
    "table_number": 7,
    "table_name": "A1",
    "guest_count": 5,
    "destination": "DINE-IN",
    "customer": {
        "name": "KC",
        "phone": "1234567890"
    },
    "list_item": [{
        "menu_id": "1520561495019",
        "qty": 1,
        "id": "1751109810015",
        "subtotal": 104,
        "name": "Burger",
        "price": 104,
        "seat": "1",
        "taxTable": ["", "YES", "YES"],
        "printerTable": ["", "YES", "YES"],
        "report_department": "ENTREES",
        "report_product": "BURGER"
    }],
    "user_id": "1",
    "user_name": "GM3",
    "service_fee": 187,
    "created": 1750960287,
    "created_date": "06/26/2025",
    "created_time": "01:51:27 PM",
    "customer_id": -1,
    "type": "TICKET",
    "buy_mode": "SALE",
    "version": 2,
    "seated": 1750960287,
    "terminal_number": "1",
    "modified": 1751159543,
    "modified_human": "06/28/2025 09:12:23 PM",
    "register_number": "1",
    "report_date": "20250626"
}

Key Fields:

tax (Number) - Total tax amount
subtotal (Number) - Subtotal before tax
total (Number) - Total including tax
balance (Number) - Remaining balance
status (String) - Ticket status (OPEN, CLOSED, etc.)
number (Number) - Ticket/order number
table_number (Number) - Table number if dine-in
table_name (String) - Table name/identifier
guest_count (Number) - Number of guests
destination (String) - Order type (DINE-IN, TAKE-OUT, DELIVERY)
customer (Object) - Customer information
list_item (Array) - Array of order items
user_id / user_name - User who created the ticket
created (Number) - Unix timestamp
modified (Number) - Unix timestamp

cart / order

Shopping cart or order data containing items with modifiers and details.

Used in: Table API (createTicketWithOrder, addOrder)

Structure:

{
    "qty": 3,
    "subtotal": 5197,
    "itemList": [{
        "menu_id": 1715030139097,
        "qty": 1,
        "id": "1720657001000",
        "modifier_id": "1715807449141",
        "subtotal": 1799,
        "modifier": {
            "list": [{
                "id": "1715817774535",
                "category_id": "1716334025116",
                "modifier_id": "1715807449141",
                "price": 0,
                "name": "CLASSIC SANDWICH",
                "text": "Classic Sandwich",
                "action": "",
                "qty": 1
            }],
            "price": 100
        },
        "name": "Sandwich Combo",
        "price": 1699,
        "seat": 1,
        "taxTable": ["YES"],
        "printerTable": ["YES"],
        "report_screen": "MAIN",
        "report_department": "LUNCH COMBO",
        "report_product": "SANDWICH COMBO",
        "lineID": "1720657001000"
    }]
}

Fields:

qty (Number) - Total quantity of items
subtotal (Number) - Total subtotal amount
itemList (Array) - Array of order items

Item Fields:

menu_id (Number) - Menu item ID
qty (Number) - Quantity
id (String) - Unique item instance ID
modifier_id (String) - Modifier template ID
subtotal (Number) - Item subtotal
modifier (Object) - Modifier details with list and price
name (String) - Item name
price (Number) - Item price
seat (Number) - Seat number
taxTable (Array) - Tax applicability
printerTable (Array) - Printer routing
report_screen / report_department / report_product - Reporting classifications
lineID (String) - Unique line identifier

opts

Options object used for filtering and configuring API requests.

Used in: Table API (createTicket, createTicketWithOrder), Ticket API (getList)

For Table Operations:

{
    "userName": "GM3",
    "userID": "1",
    "terminalID": "1",
    "terminalNumber": "1",
    "registerNumber": "1",
    "destination": "DINE-IN"
}

Fields:

userName (String) - User's display name
userID (String) - User identifier
terminalID (String) - Terminal identifier
terminalNumber (String) - Terminal number
registerNumber (String) - Register number
destination (String) - Order destination (DINE-IN, TAKE-OUT, DELIVERY)

For Ticket Filtering:

{
    "folder": "SALES_CLOSED",
    "limit": 100,
    "offset": 0,
    "filters": {
        "user_id": "1",
        "created_start": 1720000000,
        "created_end": 1720999999
    }
}

Fields:

folder (String) - Target folder
limit (Number) - Maximum results to return
offset (Number) - Starting offset for pagination
filters (Object) - Filter criteria (see filters)

filters

Filter criteria for searching tickets.

Used in: Ticket API (getList via opts)

Structure:

{
    "user_id": "1",
    "terminal_number": "3",
    "created_start": 1720000000,
    "created_end": 1720999999,
    "number": 1002,
    "table_number": 7,
    "destination": "DINE-IN",
    "status": "OPEN"
}

Available Filters:

user_id (String) - Filter by user ID
terminal_number (String) - Filter by terminal
created_start (Number) - Start timestamp
created_end (Number) - End timestamp
number (Number) - Specific ticket number
table_number (Number) - Filter by table
destination (String) - Filter by order type
status (String) - Filter by ticket status

configList

Configuration list for retrieving system settings by level and name.

Used in: Configuration API

Request Structure:

[
    {"level": "STORE", "name": "NAME"},
    {"level": "STORE", "name": "PHONE"},
    {"level": "STORE", "name": "STREET"},
    {"level": "STORE", "name": "CITY"},
    {"level": "STORE", "name": "STATE"},
    {"level": "STORE", "name": "ZIPCODE"}
]

Response Structure:

[
    {"level": "STORE", "name": "NAME", "value": "Tom's Restaurant"},
    {"level": "STORE", "name": "PHONE", "value": "555-1234"},
    {"level": "STORE", "name": "STREET", "value": "123 Main St"}
]

Fields:

level (String) - Configuration level (STORE, TERMINAL, USER, etc.)
name (String) - Configuration key name
value (String) - Configuration value (in response)

customer

Customer information object.

Used in: Customer API, Ticket Data

Structure:

{
    "phone": "1234567890",
    "name": "John Doe",
    "email": "john@example.com",
    "street": "123 Main St",
    "city": "Los Angeles",
    "state": "CA",
    "zipcode": "90001"
}

Fields:

phone (String) - Customer phone (required, used as ID)
name (String) - Customer name
email (String) - Email address
street (String) - Street address
city (String) - City
state (String) - State
zipcode (String) - ZIP code

waiting

Waiting list entry data.

Used in: Waiting List API

Structure:

{
    "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"
}

Fields:

phone (String) - Customer phone
name (String) - Customer name
size (Number) - Party size
location (String) - Dining location preference
seat (String) - Seating preference
option (Array) - Special options/tags
memo (String) - Notes
quoted (Number) - Estimated wait time (timestamp)
id (String) - Unique waiting list entry ID
created (Number) - Creation timestamp
number (Number) - Queue number
terminal_number / user_id / user_name - Creation info
modified (Number) - Last modified timestamp
modified_human (String) - Human-readable modified time

Menu data structure containing products, departments, and modifiers.

Used in: Menu API

Structure:

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

Fields:

id (String) - Menu ID
name (String) - Menu name
type (String) - Always "MENU"
menu (Object) - Menu items organized by category
department (Object) - Department/category definitions
modifier_component (Object) - Individual modifiers
modifier_template (Object) - Modifier groups/templates
combo (Object) - Combo meal definitions
combo_template (Object) - Combo templates
priority (Number) - Display priority
created / modified (String) - Timestamps
deleted (Number) - Deletion flag

map

Restaurant floor plan and table layout data.

Used in: Map API

Structure:

{
    "name": "MAIN FLOOR",
    "width": 1024,
    "height": 768,
    "floorList": [...],
    "itemList": [...],
    "type": "MAP",
    "id": "28118",
    "modified": "1621341676",
    "created": "1621341615",
    "lock_id": "0",
    "deleted": 0
}

Fields:

id (String) - Map ID
name (String) - Map/floor name
type (String) - Always "MAP"
width / height (Number) - Canvas dimensions
floorList (Array) - List of floors
itemList (Array) - List of tables and items on the map
created / modified (String) - Timestamps
deleted (Number) - Deletion flag