ShAlcListPrepare

Purpose	Obtaining a list of cocktail recipe cards
Request type	asynchronous/synchronous
Supported agent version, sh	WSA v2.8.5.4 SH5
PluggetSystemType	StoreHouse

Request format

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

       "timeout": number
    },
    "restaurantGuid": "string (guid)",
    "placeGuid": "string (guid)",
    "date": "string",
    "dishes": [
       {
         "rkGuid": "string (guid)",
         "amount": number
       }
    ]

   }
}

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	+	Guid in SH Point of Sale
date	Date	-	Date for calculation (if null then current date is used)
dishes	array	+	Array: list of goods-dishes for calculation
\|- rkGuid	guid	+	Guid in RK Product
\|- amount	double	+	Quantity of goods (In units of measurement for applications. Default is Portion)

Response format

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

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

Parameter	Parameter type	Description
dishes	array	Array: list of goods-dishes
\|- guid	guid	Product: GUID
\|- amount	double	Quantity of goods
\|- ingredients	array	Array: List of ingredients
\|- guid	int	GUID SH of ingredient — SH product (GUID Sh is different from GUID RK for the same product)
\|- guidRk	int	GUID RK of the ingredient — product SH (calculated as XOR of two GUIDs GUID SH of the ingredient and GUID of the product group associated with the enterprise from the input parameters)
\|- rid	int	Rid of product Ingredient
\|- name	string	Name of product ingredient
\|- amount	double	Quantity of ingredient (in units for alcohol, default is Liter)
\|- alcCodes	string[]	Array of EGAIS product codes