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			Синхронный вызов метода (либо синхронный, либо асинхронный. Для этого изменить на "async")
\|-timeout	int	-	Время ожидания ответа от агента в секундах, по умолчанию 120 секунд	120 секунд
\|-objectId	int	+	Код ресторана в системе лицензирования
tableCode	number	-	Код стола, для которого возвращается список заказов. Может быть null - возвращает список заказов со всех столов но, только если есть разрешение "запрос заказов со всех столов" в настройках ресторана в админке WS
withClosed	boolean	-	Если значение true, то возвращает все заказы, иначе только активные. Запрос со значением true возможен только если есть разрешение "запрос закрытых заказов" в настройках ресторана в админке WS

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

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

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

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

CODE

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

{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetOrderList",
    "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)

|- isReturn

boolean

-

Признак возвратного заказа

error

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

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

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

Примеры структуры запросов

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

{
    "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,
                "isReturn": 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,
                "isReturn": false,
                "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,
                "isReturn": false
            },
 
 
        ]
    },
    "responseCommon": {
        "taskGuid": "03046fb4-7c57-4884-9d08-a05c24123273",
        "taskType": "GetOrderList",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

{
    "responseCommon": {
        "taskGuid": "72e8b9d9-235b-4904-a25b-0e918d084f83",
        "taskType": "GetOrderList",
        "objectId": 199990232
    },
    "error": {
        "wsError": {
            "code": "Request is restricted",
            "desc": "Запрос GetOrderList c параметром WithClosed = true не разрешен настройками ресторана"
        }
    }
}

{
  "responseCommon": {
    "taskGuid": "eadc193e-8f1a-4b19-9976-f6d072c0b602",
    "taskType": "GetOrderList",
    "objectId": 199990232,
    "agentGuid": "a8d4d003-5b47-42df-bf1f-8e5a3487f4ca"
  },
  "error": {
    "agentError": {
      "code": "WsaOrderError",
      "desc": "RkXmlApiError: connect 127.0.0.1:5321. Error=10061 Connection refused"
    }
  }
}