ShGetGoods

Назначение	Получение списка товаров
Тип запроса	Асинхронный/синхронный
Поддерживаемая версия агента, sh	v1 для Store House 4 b Store House 5, v2 для Store House 5
PluggetSystemType	StoreHouse

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

{
  "taskType": "ShGetGoods",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
     "goodGroupRid": number
  }
}

JSON

Параметр	Тип	Обязательный	Описание
taskType	string	да	Тип задачи
-async			Асинхронный вызов метода: либо синхронный, либо асинхронный
-sync			Синхронный вызов метода: либо синхронный, либо асинхронный
--timeout	int	нет	Время ожидания ответа от агента в секундах. По умолчанию — 120 секунд
--objectId	int	да	Код ресторана в системе лицензирования
-goodGroupRid			rid товарной группы, товары из которой нужно вывести

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

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

JSON

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

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

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

{
   "taskResponse":{
      "items":[
         {
            "mUnits":[
               {
                  "rid":"number",
                  "name":"string",
                  "isBase":"number",
                  "barCodes":[
                     {
                        "val":"string"
                     }
                  ]
               }
            ],
            "rid":"number",
            "name":"string"
         }
      ]
   },
   "responseCommon":{
      "taskGuid":"string",
      "taskType":"ShGetGoods",
      "objectId":"number"
   }
}

JSON

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

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

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

JSON

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