Order
The Order query model for events is the contents of the eventParams section.
Format
JSON
|
Parameter | Parameter type | Mandatory | Description |
---|---|---|---|
Parameter | Parameter type | Mandatory | Description |
orderGuid | string | yes | Order guid |
createdAt | dateTime | Order creation time | |
printedAt | dateTime | Guest bill printing time | |
closedAt | dateTime | Order closing time | |
waiter | string | Waiter | |
tableName | string | Table name | |
status.value | string | ||
substate | string | ||
products | |||
-id | string | yes | Dish ID |
-name | string | Name of the dish | |
-price | string | нет | The parameter is not mandatory. It can be left blank, since the order is created with the price indicated at the cash register. The separator between the integer and fractional parts of the sum must be a dot. |
-quantity | float | yes | Number of dishes |
-measure | Measure | ||
--unit | string | Unit of measurement | |
--value | string | Value | |
-ingredients | array | An array of modifiers or combo elements (ingredients or contents of a combo dish) | |
--id | int | yes | Ingredient ID |
--name | string | Ingredient name | |
--price | string | The parameter is not mandatory. It can be left blank, since the order is created with the price indicated at the cash register. The separator between the integer and fractional parts of the sum must be a dot. | |
--quantity | float | yes | Quantity of ingredients |
-voidingReason | string | Reason for removing dish from order | |
comment | string | Comment to order | |
appliedPayments | Payments and prepayments. (WSA 2 only) | ||
-amount | money | yes | The value of the amount to be paid. The separator between the integer and fractional parts of the amount must be a dot. |
-guid | guid | yes | Payment ID |
-payType | enum | yes | Payment type: Cash, Card, Unknown. |
price | yes | Order cost | |
-sumToPay | money | yes | The amount that remains to be paid. The separator between the whole and fractional parts of the amount must be a dot. |
-total | money | yes | Total cost of the order. The separator between the whole and fractional parts of the amount must be a dot. |
personsQuantity | int | Number of persons | |
rejectingReason | Reason for order cancellation | ||
-code | string | Cancellation code | |
-message | string | Reason for order cancellation |