GetOrderList
Purpose | Request a list of orders from the cash server. The request is available only if there is permission in the restaurant settings in WsAdmin |
|---|---|
| Request type | asynchronous/synchronous |
| Supported agent version, SH | WSA v2.8.5.10 |
| PluggetSystemType | RKMid |
Request format
|
Parameter | Type | Mandatory | Description |
|---|---|---|---|
| taskType | string | + | Task Type (GetOrderList) |
| sync | Synchronous method call (either synchronous or asynchronous) | ||
| |-timeout | int | - | Agent response timeout in seconds, default is 120 seconds |
| |-objectId | int | + | Restaurant code in the licensing system |
| tableCode | number | - | Table code for which the list of orders is returned. Can be null - returns a list of orders from all tables, but only if there is permission "request orders from all tables" in the restaurant settings in the White Server admin panel |
| withClosed | boolean | - | If true, returns all orders, otherwise only active ones. A request with a true value is possible only if there is a "request closed orders" permission in the restaurant settings in the White Server admin panel |
Response format
Successful response
|
Response with error
|
Parameter | Parameter type | Mandatory | Description |
|---|---|---|---|
| orders | array | + | Array: list of orders |
| |- orderGuid | Guid | + | Order Guid |
| |- tableCode | int | + | Table code |
| |- waiterId | int | + | Waiter ID |
| |- sum | decimal | + | Order amount |
| |- unpaid | decimal | + | How much is left to pay |
| |- isFinished | boolean | + | Indication that the order is closed |
| |- openTime | DateTime | + | Date and time of opening or start of table reservation |
| |- isReserve | boolean | + | Table/order reservation indicator for a specific time (OpenTime) |
| |- duration | string | - | Table reservation duration in HH:MM:SS format (e.g. 02:30:00) |
Example request
|
Example response
|