ShGetStores

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

В SH5 нет групп складов. Вместо складов используются подразделения. Поэтому создается одна статическая группа – «Подразделения». В эту группу добавляются все подразделения, которые есть в SH5. В SH5 не возвращаются атрибуты склада.

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

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

CODE

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

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

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

CODE

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

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

// Успешный ответ
{
   "taskResponse":{
      "storeGroups":[
         {
            "stores":[
               {
                  "attributes":[
                     {
                        "name": "string",
                        "value":"string"
                     }
                  ],
                  "rid": number,
                  "name": "string",
                  "kppList": [
                      {
                          "rid": number,
                          "kpp": "string",
                          "isDefault": boolean,
                          "isClosed": boolean,
                          "externalCode": "string"
                      }
                  ],
                  "type": number               
               }
            ],
            "rid": number,
            "name": "string",
            "parent": "number"
         }
      ]
   },
   "responseCommon":{
      "taskGuid": "string",
      "taskType": "ShGetStores",
      "objectId": number
   }
}
   
// Ответ с ошибкой
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "ShGetStores",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

CODE

Параметр	Тип параметра	Обязательный	Описание
storeGroups	array
rid	int		rid группы складов
name	string		Название группы складов
parent	int?		rid группы складов, в которую вложена текущая (если корневая группа, то возвращается пустая строка)
stores	array
rid	int		rid склада
name	string		Название склада
type	number		тип подразделения (по ИЛИ): 1 - склад 2 - производство 4 - торговля например: 7 это 4+2+1 (т.е. и склад и производство и торговля) 5 это 4+1 (торговля и склад) и т.д.
attributes	array
name	string		Название атрибута
value	string		Значение атрибута
kppList	array	-	Список КПП подразделения (получателя). Значения кэшируются в файл на диске "C:\ProgramData\UCS\WhiteServerAgent\Obj_<objectId>\Cache\shGetStores.kpp.cache.json" Обновляется при старте агента и каждые 60 мин. Подставляются из кэша при выполнении запроса.
rid	int	+	rid КПП
kpp	string	+	Значение КПП, чаще всего 9 символов
isDefault	boolean	-	Значение по умолчанию
isClosed	boolean	-	Значение флага "Закрыт"
externalCode	string	-	Внешний код
error	string enum		Контейнер ошибок, см. Описание ошибок

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

{
  "taskResponse": {
  "storeGroups": [
{
  "stores": [
{
  "rid": 92274688,
  "name": "RK7",
  "type": 7
},
{
  "rid": 88080384,
  "name": "Центральный склад",
  "kppList": [
{
  "rid": 29,
  "kpp": "774201001",
  "isDefault": true,
  "externalCode": "030000198400"
}
],
  "type": 5
},
{
  "rid": 83886083,
  "name": "Склад 2 для Алкоголя",
  "kppList": [
{
  "rid": 40,
  "kpp": "501803001",
  "isDefault": true
},
{
  "rid": 39,
  "kpp": "774201001"
}
],
  "type": 7
},
{
  "rid": 79691778,
  "name": "Склад 1 для Алкоголя",
  "kppList": [
{
  "rid": 39,
  "kpp": "774201001",
  "isDefault": true
}
],
  "type": 7
},
{
  "rid": 75497473,
  "name": "Кухня Ресторан 3",
  "type": 7
},
{
  "rid": 71303168,
  "name": "Бар Ресторан 3",
  "type": 7
},
{
  "rid": 67108864,
  "name": "Кондитерский цех",
  "kppList": [
{
  "rid": 30,
  "kpp": "5029104268",
  "isDefault": true
}
],
  "type": 7
},
{
  "rid": 62914560,
  "name": "Бар 2 этаж Ресторан 1",
  "kppList": [
{
  "rid": 30,
  "kpp": "5029104268",
  "isDefault": true
},
{
  "rid": 29,
  "kpp": "774201001",
  "externalCode": "030000198400"
}
],
  "type": 5
},
{
  "rid": 58720260,
  "name": "Хоз. товары Фабрика кухни",
  "type": 5
},
{
  "rid": 54525955,
  "name": "Хоз. товары Ресторан 2",
  "type": 5
},
{
  "rid": 50331650,
  "name": "Химия Ресторан 2",
  "type": 5
},
{
  "rid": 46137345,
  "name": "Химия Ресторан 1",
  "type": 5
},
{
  "rid": 41943040,
  "name": "Хоз. товары Ресторан 1",
  "type": 5
},
{
  "rid": 37748738,
  "name": "Фабрика-кухня рыбный цех",
  "type": 7
},
{
  "rid": 33554433,
  "name": "Фабрика-кухня мясной цех",
  "type": 7
},
{
  "rid": 29360128,
  "name": "Фабрика-кухня овощной цех",
  "type": 7
},
{
  "rid": 25165829,
  "name": "Кухня Ресторан 2",
  "kppList": [
{
  "rid": 31,
  "kpp": "770101001",
  "isDefault": true,
  "externalCode": "030000203510"
}
],
  "type": 7
},
{
  "rid": 20971524,
  "name": "Бар Ресторан 2",
  "kppList": [
{
  "rid": 31,
  "kpp": "770101001",
  "isDefault": true,
  "externalCode": "030000203510"
}
],
  "type": 7
},
{
  "rid": 16777219,
  "name": "Основной склад Ресторан 2",
  "kppList": [
{
  "rid": 31,
  "kpp": "770101001",
  "isDefault": true,
  "externalCode": "030000203510"
}
],
  "type": 5
},
{
  "rid": 12582914,
  "name": "Бар 1 этаж Ресторан 1",
  "kppList": [
{
  "rid": 29,
  "kpp": "774201001",
  "isDefault": true,
  "externalCode": "030000198400"
}
],
  "type": 7
},
{
  "rid": 8388609,
  "name": "Кухня Ресторан 1",
  "kppList": [
{
  "rid": 30,
  "kpp": "5029104268"
},
{
  "rid": 29,
  "kpp": "774201001",
  "isDefault": true,
  "externalCode": "030000198400"
}
],
  "type": 7
},
{
  "rid": 4194304,
  "name": "Основной склад Ресторан 1",
  "kppList": [
{
  "rid": 30,
  "kpp": "5029104268"
},
{
  "rid": 29,
  "kpp": "774201001",
  "isDefault": true,
  "externalCode": "030000198400"
}
],
  "type": 7
}
],
  "rid": 0,
  "name": "Подразделения"
}
]
},
  "responseCommon": {
  "taskGuid": "62770526-32fa-4582-953b-90938761858b",
  "taskType": "ShGetStores",
  "objectId": 199990377,
  "agentGuid": "d564619a-50c3-3d87-0816-de67ed9c8e18"
}
}