CancelOrder

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

ФОРМАТ ЗАПРОСА

Запрос

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

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

ФОРМАТ ОТВЕТА

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

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

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

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

Параметр

Тип

Описание

taskGuid

guid

Уникальный код этой задачи используется при получении задачи через очередь

taskType

string

Тип задачи

objectId

int

Код ресторана в системе лицензирования

error

string enum

Контейнер ошибок, см Описание ошибок

wsError		Ошибка от сервера
agentError		Ошибка от агента

ПРИМЕРЫ СТРУКТУРЫ ЗАПРОСОВ

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

{
  "taskResponse": {
    "status": "Ok"
  },
  "responseCommon": {
    "taskGuid": "5420dbf5-7580-4b46-97cb-d6ca9664ada5",
    "taskType": "CancelOrder",
    "objectId": 199990232,
    "agentGuid": "62225260-c097-4c75-abef-106c7207f9ff"
  }
}

{
  "responseCommon": {
    "taskGuid": "4f190e64-f8e8-4411-9f76-30f76191d06a",
    "taskType": "CancelOrder",
    "objectId": 199990232,
    "agentGuid": "62225260-c097-4c75-abef-106c7207f9ff"
  },
  "error": {
    "agentError": {
      "code": "WsaOrderError",
      "desc": "RkInternal: Касса [3181] DeleteReason с кодом '1234' не найден."
    }
  }
}