GetStopList

Описание

Назначение	Получить список ограниченных блюд и стоп-листа
Поддерживаемая версия агента	v1, v2
PluggetSystemType	RKMid

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

Запрос

{
  "taskType": "GetStopList",
  "params": {
    "sync": {
      "objectId": "string",
      "timeout": number
    }
  }
}

SQL

Параметр	Тип	Обязательный	Описание	Значение по умолчанию
taskType	string	да	Тип задачи
sync			Синхронный вызов метода
objectId	int	да	Код ресторана в системе лицензирования
timeout	int	-	Время ожидания ответа от агента (сек)	120

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

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

{
  "taskResponse": {
     "stopList": {
       "dishes": [
         {
           "id": "string",
           "name": "string",
           "type": "string"
         }
       ]
     },
     "limitedList": {
       "dishes": [
         {
           "id": "string",
           "name": "string",
           "type": "string",
           "quantity": decimal
         }
       ]
     },
     "modifierStopList": {
       "dishes": [
         {
           "id": "string",
           "name": "string",
           "type": "string",
           "quantity": decimal
         }
       ]
     }
},
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetStopList",
    "objectId": 0
  }
}

SQL

Успешный ответ, но стоп-лист и список ограниченных блюд пустой

{
  "taskResponse": {
     "stopList": {
       "dishes": []
     },
     "limitedList": {
       "dishes": []
     },
     "modifierStopList": {
        "dishes": []
     },
  },
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetStopList",
    "objectId": 0
  }
}

SQL

Параметр	Тип параметра	Обязательный	Описание
taskGuid	guid	+	Идентификатор запроса
stoplist
- dishes	array		Массив элементов в стоп-листе
– id	integer		Идентификатор блюда
– name	string		Название блюда
– type	string		Тип товара. Возможные варианты: product, ingredient, category (сейчас всегда product)
limitedList
- dishes	array		Массив элементов ограниченных блюд
– id	integer		Идентификатор блюда
– name	string		Название блюда
– type	string		Тип товара. Возможные варианты: product, ingredient, category (сейчас всегда product)
– quantity	decimal		Количество остатков. Значения в ЕИ шт. или кг
modifierStopList		-
-dishes	array		Массив модификаторов в стоп-листе
– id	integer		Идентификатор блюда
– name	string		Название блюда
– type	string		Тип товара. ingredient

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

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

SQL

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

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

{
    "taskResponse": {
        "stopList": {
            "dishes": [
                {
                    "id": "1000057",
                    "name": "Шашлык",
                    "type": "product"
                }
            ]
        },
        "limitedList": {
            "dishes": [
                {
                    "id": "1000016",
                    "name": "Борщ",
                    "type": "product",
                    "quantity": 5
                }
            ]
        },
        "modifierStopList": {
            "dishes": [
                {
                    "id": "1000065",
                    "name": "Сметана",
                    "type": "ingredient"
                }
            ]
        }
    },
    "responseCommon": {
        "taskGuid": "0d4b9052-88f5-4a0b-b468-36d703852c9c",
        "taskType": "GetStopList",
        "objectId": 199990246,
        "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
    }
}

SQL