ShAlcMenuPrepare

Purpose	Obtaining cocktail recipe cards for the menu
Request type	asynchronous/synchronous
Supported agent version, SH	WSA v 2.8.5.6 SH5
PluggetSystemType	StoreHouse

Request format

{
  "taskType": "ShAlcMenuPrepare",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "restaurantGuid": "string (guid)",
    "placeGuid": "string (guid)",
    "date": "string"
   }
}

Parameter	Type	Mandatory	Description
taskType	string	+	Task type
async			Asynchronous method call (either synchronous or asynchronous)
sync			Synchronous method call (either synchronous or asynchronous)
timeout	int	-	Agent response timeout in seconds, default is 120 seconds
objectId	int	+	Restaurant code in the licensing system
restaurantGuid	guid	+	Guid in SH Enterprise
placeGuid	guid	+	Department: Guid in SH. To get a list of departments, use the WS ShGetStores request (the Departs procedure of the SH server)
date	Date	-	Date for calculation (if null – current date is used)

Response format

JSON

// Successful response
{
   "taskResponse":{
      "dishes":[
         {
            "guid": "string",
            "guidRk": "string",
            "name": "string",
            "ingredients": [
               {
                   "guid": "string",
                   "guidRk": "string",
                   "rid": number,
                   "name": "string",
                   "amount": number
               }
            ]
         }
      ]
   },
   "responseCommon":{
      "taskGuid":"string",
      "taskType":"ShAlcMenuPrepare",
      "objectId":"number"
   }
}

// Answer with error
{
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "ShAlcMenuPrepare",
    "objectId": number
  },
  "error": {
    "wsError": {
      "code": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

Parameter	Parameter type	Description
dishes	array	Array: List of dish-items that have the additional parameter "For external systems: EGAIS" set
\|- guid	guid	Item: GUID SH
\|- guidRk	guid	Item: GUID RK
\|- name	string	Item name
\|- ingredients	array	Array: List of ingredients with the "alcoholic product" mark
\|- guid	int	GUID SH of the ingredient – SH item (GUID Sh is different from GUID RK for the same item)
\|- guidRk	int	Ingredient GUID RK – SH item
\|- rid	int	Ingredient Rid
\|- name	string	Ingredient name
\|- amount	double	Quantity of ingredient (in units for alcohol, default – Liter)