GetVoidReasons
Назначение | Возвращает список доступных причин отмены заказа |
---|---|
Поддерживаемая версия агента | v2 начиная с версии 2.8.2.2 и далее |
PluggetSystemType | RKRef |
Формат запроса
{
"taskType": "GetVoidReasons",
"params": {
"async": {
"objectId": number,
"timeout": number
},
"sync": {
"objectId": number,
"timeout": number
}
}
}
CODE
Параметр | Тип | Обязательный | Описание |
---|---|---|---|
taskType | string | + | Тип задачи, для данного метода значение "GetVoidReasons" |
async | Асинхронный вызов метода (либо синхронный, либо асинхронный) | ||
sync | Синхронный вызов метода (либо синхронный, либо асинхронный) | ||
timeout | int | - | Время ожидания ответа от агента в секундах, по умолчанию 120 секунд |
objectId | int | + | Код ресторана в Системе лицензирования |
Пример запроса
{
"taskType": "GetVoidReasons",
"params": {
"sync": {
"objectId": 199990001
}
}
}
CODE
Формат ответа
Успешный ответ
{
"taskResponse": {
"voidReasons": [
{
"name": string,
"code": number
}
]
},
"responseCommon": {
"taskGuid": string,
"taskType": "GetVoidReasons",
"objectId": int
}
}
CODE
Ответ с ошибкой
{
"responseCommon": {
"taskGuid": "string",
"taskType": "GetVoidReasons"
},
"error": {
"wsError": {
"code": "string",
"desc": "string"
}
}
}
CODE
Пример ответа
{
"taskResponse": {
"voidReasons": [
{
"name": "Ошибка оф-та без сп.",
"code": 1
},
{
"name": "Отказ без сп.",
"code": 2
},
{
"name": "Ошибка оф-та со сп.",
"code": 3
},
{
"name": "Отказ со сп.",
"code": 4
},
{
"name": "Аннулирование чека",
"code": 5
},
{
"name": "Удаление предоплаты",
"code": 6
},
{
"name": "Удаление нераспечатанного блюда",
"code": 100007
},
{
"name": "Для возврата блюд",
"code": 8
},
{
"name": "Отмена через WS",
"code": 7
},
{
"name": "Сбой при создании заказа через WSA",
"code": 10
},
{
"name": "Обновление заказа через WS",
"code": 11
}
]
},
"responseCommon": {
"taskGuid": "201db53b-70cb-45e1-8584-87898aeb261d",
"taskType": "GetVoidReasons",
"objectId": 199990246,
"agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
}
}
CODE