GetOrderList

Назначение	Запрос списка заказов с кассового сервера. Запрос доступен только если есть разрешение в настройках ресторана в WsAdmin
Тип запроса	асинхронный/синхронный
Поддерживаемая версия агента, SH	WSA v2.8.5.10
PluggetSystemType	RKMid

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

{
    "taskType": "GetOrderList",
    "params": {
        "sync": {
            "objectId": number,
            "timeout": number
        },

        "tableCode": number,
        "withClosed": boolean


    }
}

CODE

Параметр	Тип	Обязательный	Описание
taskType	string	+	Тип задачи (GetOrderList)
sync			Синхронный вызов метода (либо синхронный, либо асинхронный)
\|-timeout	int	-	Время ожидания ответа от агента в секундах, по умолчанию 120 секунд
\|-objectId	int	+	Код ресторана в системе лицензирования
tableCode	number	-	Код стола, для которого возвращается список заказов. Может быть null - возвращает список заказов со всех столов но, только если есть разрешение "запрос заказов со всех столов" в настройках ресторана в административной панели White Server
withClosed	boolean	-	Если значение true, то возвращает все заказы, иначе только активные. Запрос со значением true возможен только если есть разрешение "запрос закрытых заказов" в настройках ресторана в административной панели White Server

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

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

{
    "taskResponse": {
        "orders": [
            {
                "orderGuid": string,
                "tableCode": number,
                "waiterId": number,
                "sum": number,
                "unpaid": number,
                "isFinished": boolean,
                "openTime": DateTime,
                "isReserve": boolean,
                "duration": string
             }
        ]
    },
    "responseCommon": {
        "taskGuid": string,
        "taskType": "GetOrderList",
        "objectId": nubmer
    }
}

CODE

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

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "PatchOrder",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

CODE

Параметр	Тип параметра	Обязательный	Описание
orders	array	+	Массив: список заказов
\|- orderGuid	Guid	+	Guid заказа
\|- tableCode	int	+	Код стола
\|- waiterId	int	+	ID официанта
\|- sum	decimal	+	Сумма заказа
\|- unpaid	decimal	+	Сколько осталось оплатить
\|- isFinished	boolean	+	Признак, что заказ закрыт
\|- openTime	DateTime	+	Дата и время открытия или начала резерва стола
\|- isReserve	boolean	+	Признак резерва стола/заказа на определенное время (OpenTime)
\|- duration	string	-	Продолжительность резервирования стола в формате ЧЧ:ММ:СС (например 02:30:00)

Пример запроса

{
    "taskType": "GetOrderList",
    "params": {
        "sync": {
            "objectId": "199990246",
            "timeout": 120
        },
        "tableCode": 247,
        "withClosed": true
    }
}

CODE

Пример ответа

{
    "taskResponse": {
        "orders": [
            {
                "orderGuid": "d06a58d0-75c8-42f9-b836-e1afdffb53fa",
                "tableCode": 247,
                "waiterId": 1,
                "sum": 0,
                "unpaid": 0,
                "isFinished": true,

                "createTime": "2024-06-22T07:14:24",
                "isReserve": false
            },

            {
                "orderGuid": "f85e0efa-bff9-4a12-b5f6-56722b58e6a1",
                "tableCode": 3,
                "waiterId": 9001,
                "sum": 0,
                "unpaid": 0,
                "isFinished": false,
                "createTime": "2024-06-26T17:00:00",
                "isReserve": true,
                "duration": "02:50:00"
            },
            {
                "orderGuid": "dffbb7c2-dea8-4905-805c-edb5d8e61767",
                "tableCode": 3,
                "waiterId": 9001,
                "sum": 408.5,
                "unpaid": 408.5,
                "isFinished": false,
                "createTime": "2024-06-25T17:12:36",
                "isReserve": false
            },


        ]
    },
    "responseCommon": {
        "taskGuid": "03046fb4-7c57-4884-9d08-a05c24123273",
        "taskType": "GetOrderList",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

CODE