UpdateOrder

Purpose	Update order composition in restaurant by order id and objectId
Request type	Asynchronous/synchronous
Supported agent version	v2
PluggetSystemType	RKMid

Request format

JSON

{
  "taskType": "UpdateOrder",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "orderGuid": "uuid",
    "products": [
        { // simple variant
            "id": number,
            "name": "string",
            "price": number, // the parameter is not mandatory. It can be left blank, since the order is created with the price indicated at the cash register
            "quantity": number,
            "discountIds": [
                {
                    "id": number,
                    "value":number
                }
            ]
        },
        { // variant with modifiers or combo
            "id": number,
            "name": "string",
            "price": number, // the parameter is not mandatory. It can be left blank, since the order is created with the price indicated at the cash register
            "quantity": number,
            "ingredients": [ //array of modifiers or combo elements
             {
                "id": number,
                "name": "string",
                "quantity": number,
                "price": number, // the parameter is not mandatory. It can be left blank, since the order is created with the price indicated at the cash register
                "ingredients": [ //array of modifiers for combo components. Only from agent version 2.7.9.1
                   {
                     "id": number,
                     "name": "string",
                     "quantity": number,
                     "price": number // the parameter is not mandatory. It can be left blank, since the order is created with the price indicated at the cash register
                   }
                ]
             }
            ]
        }
    ],
    "delivery": {
       "address": {
           "comment": "string",
           "fullAddress": "string"
       }
    },
    "discountIds": [
           number,
           number
        ],
// or
        "discountIds": [
            {
                "id": number,
                "value":number
            }
        ],
   }
}

Parameter	Type	Mandatory	Description
Parameter	Type	Mandatory	Description
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
orderGuid	uuid	yes	Unique order identifier
products	array	no	Order contents. If not specified, the contents is not updated.
- id	int	yes	Dish ID
- name	string		Name of the dish
- price	money		Price for one dish. The separator between the whole and fractional parts of the amount must be a dot
- quantity	money	yes	Number of dishes
- ingredients	array		Ingredients or contents of a combo dish
– id	int	yes	Ingredient ID
- discountIds			An array of cash discount identifiers for a dish. A discount must be specified, otherwise it will be deleted.
- id			Discount ID
- value			Discount value. Specify the amount or percentage. 0 – full application of the discount. Both positive and negative values can be specified.

discountIds	int[]/ object[]	no	Array of IDs of cash discounts GetRefData(DISCOUNTS).Ident. If the discount was specified when creating the order, then it is necessary to specify it during UpdateOrder, otherwise the discount will be deleted
- id	int	yes	Discount ID
- value	decimal	no	Discount value. Specify the amount or percentage. 0 – full application of the discount. Both positive and negative values can be specified
delivery	object?	no	Restaurant courier delivery
\|- address	object?	no	Address
\|- comment	string?	no	Comment on the address. If not specified or null, no update occurs
\|- fullAddress	string?	no	Delivery address. If not specified or null, no update occurs

Response format

JSON

{
   "responseCommon":{
      "taskGuid":"guid",
      "taskType":"UpdateOrderProducts",
      "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