CompleteOrder
| Назначение | Завершает заказ, если внесенная предоплата равна сумме заказа. После выполнения этой команды оплаченный заказ становится недоступным для редактирования. |
|---|---|
| Тип запроса | асинхронный/синхронный |
| Поддерживаемая версия агента | v2 |
| PluggetSystemType | RKMid |
Формат запроса
{
"taskType": "CompleteOrder",
"params": {
"async": {
"objectId": number,
"timeout": number
},
"sync": {
"objectId": number,
"timeout": number
},
"cashStationId": number,
"orderGuid": "guid"
}
}
JSON
Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| taskType | string | да | Тип задачи |
| -async | Асинхронный вызов метода: либо синхронный, либо асинхронный | ||
| -sync | Синхронный вызов метода: либо синхронный, либо асинхронный | ||
| --timeout | int | нет | Время ожидания ответа от агента в секундах, по умолчанию — 120 секунд |
| --objectId | int | да | Код ресторана в системе лицензирования |
| -orderGuid | guid | да | Guid заказа, по которому требуется провести оплату |
| cashStationId | int | - | Id кассовой станции, если не указан, берется из параметров ресторана установленных в административной панели WS. При указании кассовой станции с mid, отличного от выбранного в "параметрах создания заказа", указываем этот mid в поле systemName Маршрутизация запросов |
Формат синхронного ответа
{
"responseCommon":{
"taskGuid":"guid",
"taskType":"CompleteOrder",
"objectId": number
},
"error":{
"wsError":{
"code":"string",
"desc":"string"
}
}
}
JSON
Параметр | Тип | Описание |
|---|---|---|
| -taskGuid | guid | Уникальный код этой задачи, используется при получении задачи через очередь |
| -taskType | string enum | Тип задачи |
| -objectId | int | Код ресторана в системе лицензирования |
| error | Контейнер ошибок, подробнее читайте в статье Описание ошибок |
Формат асинхронного ответа
// Успешный ответ - значит, оплаченный заказ проверен и завершён; теперь его изменять нельзя.
{
"taskResponse": {
"order": {
"price": {
"total": number,
}
}
},
"responseCommon": {
"taskGuid": "string",
"taskType": "CompleteOrder",
"objectId": number
}
}
// Ответ с ошибкой
{
"responseCommon": {
"taskGuid": "string",
"taskType": "CompleteOrder",
"objectId": number
},
"error": {
"wsError": {
"code": "string",
"desc": "string"
},
"agentError": {
"code": "string",
"desc": "string"
}
}
}
CODE
Параметр | Тип параметра | Обязательный | Описание | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| order | да | ||||||||||
| price.total | money | да | Полная стоимость заказа | ||||||||
| error | string enum | Контейнер ошибок, подробнее читайте в статье Описание ошибок | |||||||||
| -wsError | string enum | Ошибка Whiteserver | |||||||||
| --code | string | Код ошибки | |||||||||
| --desc | string | Описание ошибки | |||||||||
| -agentError | string enum | Ошибка от агента | |||||||||
| --code | string | Кроме существующих, появятся такие коды ошибок (в старом агенте — цифрами):
| |||||||||
| --desc | string | Описание ошибки |