CancelOrder

Описание

Назначение	Отмена заказа, уже созданного на кассе. Может отменять только открытые заказы. Если в заказе есть пречек или оплаты/предоплаты, то проверяется настройка «Разрешить удалять оплаченные заказы». Если она включена, то такой заказ можно удалить, иначе - нет.
Тип запроса	Асинхронный/синхронный
Поддерживаемая версия агента	v1, v2
PluggetSystemType	RKMid

Формат запроса

{
  "taskType": "CancelOrder",
  "params": {
    "async": {
      "objectId": "string"
    },
    "cashStationId": number,
    "orderGuid": "string"
    "voidReasonCode": number,
    "comment": "string",
    "attributes": [ "string", "string" ]
 }
}

Параметр	Тип	Обязательный	Описание
taskType		+	Тип задачи
async			Асинхронный метод
timeout	int	-	Время ожидания ответа от агента в секундах, по умолчанию 120 секунд
orderGuid	guid	+	guid заказа, состояние которого нужно получить (либо orderGuid, либо taskGuid)
voidReasonCode	int	-	Код причины отмены заказа. Если не указан используется причина, указанная в настройках ресторана
comment	string	-	Комментарий при отмене заказа. Обрабатывается только в мультиагенте доставки
attributes	string[]	-	Массив дополнительных атрибутов. Обрабатывается только в мультиагенте доставки
cashStationId	int	-	Id кассовой станции, если не указан, берется из параметров ресторана установленных в административной панеле WS При указании кассовой станции с mid, отличного от выбранного в "параметрах создания заказа", указываем этот mid в поле systemName Маршрутизация запросов

Формат ответа

{  
   "responseCommon":{  
      "taskGuid":"guid",
      "taskType":"CancelOrder",
      "objectId":0
   },
   "error":{  
      "wsError":{  
         "code":"string",
         "extCode":"string",
         "desc":"string"
      }
   }
}

Параметр	Тип	Описание
taskGuid	guid	Уникальный код этой задачи используется при получении задачи через очередь
taskType	string enum	Тип задачи
objectId	int	Код ресторана в системе лицензирования
error		Контейнер ошибок, внутри детализация по связанным системам
- wsError		Ошибки, получаемые от сервиса WhiteServer
– code	string	Код ошибки
– extCode	string	Расширенный код ошибки
– desc	string	Описание ошибки

Формат асинхронного ответа

Успешный ответ

{
  "taskResponse": {
     "status": "string"
  },
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "CancelOrder",
    "objectId": 0
  }
}

Ответ с ошибкой

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "CancelOrder",
    "objectId": 0
  },
  "error": {
    "wsError": {
      "code": "string",
      "extCode": "string",
      "desc": "string"
    },
    "agentError": {
      "code": 0,
      "desc": "string"
    }
  }
}

Описание параметров

Параметр	Тип параметра	Описание
status	string	Ok - заказ успешно отменился
error	string enum	Контейнер ошибок, внутри детализация по связанным системам
- wsError	string enum	Ошибка Whiteserver
– code	int	Код ошибки
– extCode	string	Расширенный код ошибки
– desc	string	Описание ошибки
- agentError	string enum	Ошибка Агента
– code	int	Код ошибки
– desc	string	Описание ошибки