ShGetGoods

Purpose	Getting a list of items
Request type	Asynchronous/synchronous
Supported agent version, sh	v1 для Store House 4 b Store House 5, v2 для Store House 5
PluggetSystemType	StoreHouse

Request format

JSON

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

Parameter	Type	Mandatory	Description
taskType	string	yes	Task type
-async			Asynchronous method call: either synchronous or asynchronous
-sync			Synchronous method call: either synchronous or asynchronous
--timeout	int	no	Agent response time in seconds. Default is 120 seconds
--objectId	int	yes	Restaurant code in the licensing system
-goodGroupRid			rid of the items group from which the items need to be removed

Response format

JSON

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

Parameter	Type	Description
-taskGuid	guid	Unique code for this task. Used when receiving a task via the queue
-taskType	string enum	Task type
-objectId	int	Restaurant code in the licensing system
error		Error container, for more details see the article Error Description

Asynchronous response format

Successful response

JSON

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

Parameter	Parameter type	Description
Parameter	Parameter type	Description
-items	array
--rid	int	rid of the item
--name	string	Name of the item
--mUnits	array
---rid	int	rid of the unit
---name	string	Name of the unit
---isBase	int	If the unit of measurement is the base unit for the item (if 1, then yes)
---barCodes	array	In StoreHouse 5 it is not returned
----val	string	Barcode for the item in this unit of measurement
error	string enum	Error container, for more details see the article Error Description

Response with error

JSON

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

Parameter	Type	Description
-taskGuid	guid	Unique code for this task. Used when receiving a task via the queue
-taskType	string enum	Task type
-objectId	int	Restaurant code in the licensing system
error		Error container, for more details see the article Error Description