НазначениеПолучить статус по заказу
Тип запросаасинхронный/синхронный
Поддерживаемая версия агентаv1, v2
PluggetSystemTypeRKMid

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

{
  "taskType": "GetOrderState",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "orderGuid": "string",
    "taskGuid": "string"
  }
}
CODE
ПараметрТипОбязательныйОписание
taskType
+Тип задачи
async

Асинхронный вызов метода (либо синхронный, либо асинхронный)
sync

Синхронный вызов метода (либо синхронный, либо асинхронный)
timeoutint-Время ожидания ответа от агента в секундах, по умолчанию 120 секунд
orderGuidguid+guid заказа, состояние которого нужно получить (либо orderGuid, либо taskGuid)
taskGuidguid
guid задачи whiteserver на создание заказа (либо orderGuid, либо taskGuid)

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

{  
   "responseCommon":{  
      "taskGuid":"guid",
      "taskType":"GetOrderState",
      "objectId":0
   },
   "error":{  
      "wsError":{  
         "code":"string",
         "desc":"string"
      }
   }
}
CODE
ПараметрТипОписание
taskGuidguidУникальный код этой задачи используется при получении задачи через очередь
taskTypestring enumТип задачи
objectIdintКод ресторана в системе лицензирования
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
ПараметрТип параметраОбязательныйОписание
taskGuiduuid+Идентификатор запроса
order


- taskGuidguid
taskGuid задачи whiteserver на создание заказа
- orderGuidguid
Guid заказа в RK
status


– valuestring

Статус заказа, возможные варианты:

  • Created - новый заказ;
  • Canceled - отменен;
  • Complited - заказ оплачен из закрыт от редактирования;
  • Cooking - заказ передан на кухню
  • Ready - заказ готов к выдаче;
  • IssuedOut - заказ выдан (клиенту или курьеру).

*Агент V1 отличия: 
Unknown - заказ не найден;
Created - новый заказ;
Accepted - заказ принят;
Canceled - отменен по внешней команде во время ожидания подтверждения заказа от кассира;

– isBillPrintedbool
Флаг, показывающий, распечатан ли пречек заказа.
errorstring enum
Контейнер ошибок, смотрите описание ошибок
substatestring
Расширенный статус заказа
- rejectingReason.code

Код отмены

- rejectingReason.message

string
Причина отмены заказа