GetOrderState
Назначение | Получить статус по заказу |
---|---|
Тип запроса | асинхронный/синхронный |
Поддерживаемая версия агента | v1, v2 |
PluggetSystemType | RKMid |
Формат запроса
{
"taskType": "GetOrderState",
"params": {
"async": {
"objectId": number,
"timeout": number
},
"sync": {
"objectId": number,
"timeout": number
},
"orderGuid": "string",
"taskGuid": "string"
}
}
CODE
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
taskType | + | Тип задачи | |
async | Асинхронный вызов метода (либо синхронный, либо асинхронный) | ||
sync | Синхронный вызов метода (либо синхронный, либо асинхронный) | ||
timeout | int | - | Время ожидания ответа от агента в секундах, по умолчанию 120 секунд |
orderGuid | guid | + | guid заказа, состояние которого нужно получить (либо orderGuid, либо taskGuid) |
taskGuid | guid | guid задачи whiteserver на создание заказа (либо orderGuid, либо taskGuid) |
Формат ответа
{
"responseCommon":{
"taskGuid":"guid",
"taskType":"GetOrderState",
"objectId":0
},
"error":{
"wsError":{
"code":"string",
"desc":"string"
}
}
}
CODE
Параметр | Тип | Описание |
---|---|---|
taskGuid | guid | Уникальный код этой задачи используется при получении задачи через очередь |
taskType | string enum | Тип задачи |
objectId | int | Код ресторана в системе лицензирования |
error | Контейнер ошибок, смотрите описание ошибок |
Формат асинхронного ответа
// Успешный ответ
{
"taskResponse": {
"order": {
"orderGuid": "string",
"status": {
"value": "string",
"isBillPrinted": false
},
"substate": "string",
"rejectingReason": {
"code": "string",
"message": "string"
}
},
"responseCommon": {
"taskGuid": "string",
"taskType": "GetOrderState",
"objectId": 0
},
"error": {
"wsError": {
"code": "string",
"extCode": "string",
"desc": "string"
},
"agentError": {
"code": "string",
"desc": "string"
}
}
}
// Ответ с ошибкой
{
"responseCommon": {
"taskGuid": "string",
"taskType": "GetOrderState",
"objectId": 0
},
"error": {
"wsError": {
"code": "string",
"desc": "string"
},
"agentError": {
"code": "string",
"desc": "string"
}
}
}
CODE
Параметр | Тип параметра | Обязательный | Описание |
---|---|---|---|
taskGuid | uuid | + | Идентификатор запроса |
order | |||
- taskGuid | guid | taskGuid задачи whiteserver на создание заказа | |
- orderGuid | guid | Guid заказа в RK | |
status | |||
– value | string | Статус заказа, возможные варианты:
*Агент V1 отличия: | |
– isBillPrinted | bool | Флаг, показывающий, распечатан ли пречек заказа. | |
error | string enum | Контейнер ошибок, смотрите описание ошибок | |
substate | string | Расширенный статус заказа | |
- rejectingReason.code | Код отмены | ||
- rejectingReason.message | string | Причина отмены заказа |