ShGetGoodGroups

Назначение	Получение списка товаров и групп товаров
Тип запроса	Асинхронный/синхронный
Поддерживаемая версия агента, SH	v1(sh4, sh5), v2(sh5)
PluggetSystemType	StoreHouse

В SH5 не возвращаются штрихкоды (не реализовано в SH5).

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

{
   "taskType":"ShGetGoodGroups",
   "params":{
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "alcOnly": boolean,
    "groups":[
         {
            "rid": number,
            "withGoods": boolean
         }
      ]
   }
}

CODE

Параметр	Тип	Обязательный	Описание
taskType	string	+	Тип задачи
async			Асинхронный вызов метода (либо синхронный, либо асинхронный)
sync			Синхронный вызов метода (либо синхронный, либо асинхронный)
\|- timeout	int	-	Время ожидания ответа от агента в секундах, по умолчанию 120 секунд.
\|- objectId	int	+	Код ресторана в системе лицензирования.
alcOnly	boolean	-	Если true, то возвращает в группах только алкогольные товары. С версии агента 2.8.5.9.
groups		-	Если конкретные группы не перечислены, возвращается ВЕСЬ список групп БЕЗ товаров.
\|- rid	int		rid группы
\|- withGoods	boolean		Должны ли возвращаться товары из указанной группы.

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

{ 
   "responseCommon":{ 
      "taskGuid": "guid",
      "taskType": "ShGetGoodGroups",
      "objectId": number
   },
   "error":{ 
      "wsError":{ 
         "code": "string",
         "desc": "string"
      }
   }
}

CODE

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

Формат асинхронного ответа

// Успешный ответ
{
   "taskResponse":{
      "items":[
         {
            "goodItems":[
               {
                  "mUnits":[
                     {
                        "rid":"number",
                        "name":"string",
                        "isBase":"number",
                        "barCodes":[
                           {
                              "val":"string"
                           }
                        ]
                     }
                  ],
                  "rid":"number",
                  "name":"string"
               }
            ],
            "rid":"number",
            "name":"string",
            "parent":"number"
         }
      ]
   },
   "responseCommon":{
      "taskGuid":"string",
      "taskType":"ShGetGoodGroups",
      "objectId":"number"
   }
}
   
// Ответ с ошибкой
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "ShGetGoodGroups",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

CODE

Параметр	Тип параметра	Описание
items	array
rid	int	rid группы товаров
name	string	Название группы товаров
parent	int	rid группы предыдущего уровня
goodItems	array
rid	int	rid товара
name	string	Название товара
mUnits	array
rid	int	rid единицы измерения
name	string	Название единицы измерения
isBase	int	Является ли единица измерения базовой для товара (если 1, то является)
barCodes	array	В SH5 не возвращается
val	string	Штрихкод для товара в этой единице измерения
error	string enum	Контейнер ошибок, см. Описание ошибок