GetOrder

Purpose	Get order by Objectid+OrderGuid
Request type	asynchronous/synchronous
Supported agent version	v1, v2
PluggetSystemType	RKMid

Request format

{
  "taskType": "GetOrder",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
     "orderGuid": "guid"
  }
}

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
orderGuid	string	+	The internal keeper GUID of the order for which information is required
objectId	int	+	Restaurant code in the licensing system

Response format

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

Parameter	Type	Description
taskGuid	guid	The unique code of this task is used when receiving the task through the queue.
taskType	string enum	Task type
objectId	int	Restaurant code in the licensing system
error		Error container, inside there is detailing on related systems
- wsError		Error container, see Error Description

Asynchronous response format

// Successful response
{
  "taskResponse": {
     "order": {
        "originalOrderId": "string", // EXTERNAL ID (usually, numeric)
        "createdAt": "2008-10-17T00:00:00",
        "status": {
           "value": "string",
           "isBillPrinted": false
        },
        "delivery": {
           "expectedTime": "2008-10-17T00:00:00"
        },
        "products": [
           { // simple variant
             "ingredients": []
             "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
                 }
             ],
      },          { // the version 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,             "discountIds": [
                 {
                   "id": number,
                   "value":number
                 }
               ], "ingredients": [ //array of modifiers or combo elements               {   "id": number,
                  "name": "string",
                  "quantity": number,
                  "price": "string", // 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. Starting from agent version 2.7.9.1 only
                    {
                      "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
                   }
                  ]
   }
             ],
             "voidingReason":"string"
          }
        ],
        "comment": "string",
        "price": {
           "total": number
        },
        "appliedPayments": [ // WSA 2 only
        {
            "amount": number,
            "guid": "guid",
            "payType": "enum"
        }],
        "personsQuantity": number,
        "tableCode": number,
        "waiterId": number,
        "substate": "string",
        "queuePosition": "string",
        "rejectingReason": {
            "code": "string",
            "message": "string"
        },
        "discountIds": [
            {
                "id": number,
                "value":number
            }
        ],
        "queuePosition": "string",         "payMethod": "string"
      }
  },
  "responseCommon": {
    "taskGuid": "guid",
    "taskType": "GetOrder",
    "objectId": number
  }
}

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

Parameter	Parameter type	Mandatory	Description
Parameter	Parameter type	Mandatory	Description
order		yes
originalOrderId	string		External identifier of the order passed in the create order request.
status.value	string		Order status, possible options: - Unknown - order not found; - Created - new order; - Accepted - order accepted; - Canceled - cancelled by external command while waiting for order confirmation from cashier; - Ready - prepared (prepared for the future); - Closed - closed (considered completed in the restaurant)
status.isBillPrinted	bool		Checkbox indicating whether the guest bill has been printed.
delivery. expectedTime	DateTime		time to prepare the order by
products	array	yes	Order contents
- id	int	yes	Dish ID
- name	string		Name of the dish
- price	string		The separator between the integer and fractional parts of the sum must be a period.
- quantity	float (non-integer value - for a half portion?)	yes	Number of dishes
- voidingReason	string		Reason for removing dish from order (Agent v2 only)
- discountIds	array	-	Discounts on dishes
- id	int	+	Discount ID
- value	decimal	-	Discount value. Amount or percentage. Accepts negative values.
- ingredients	array		Ingredients or contents of a combo dish
– id	int	yes	Ingredient ID
comment	string		Comment to order
price.total	money	yes	Total order cost. The decimal separator for the integer and fractional parts of the amount should be a period.
appliedPayments			Payments and prepayments. (WSA 2 only)
- amount	money	+	The value of the amount to be paid. The separator between the integer and fractional parts of the amount must be a period.
- guid	guid	+	Unique payment fact identifier (line_guid field from R-Keeper)
- payType	enum	+	Payment type: Cash, Card, Unknown.
personsQuantity	int		Number of persons
tableCode	int		Table code (agent v2 only)
waiterId	int	+	Waiter Code (Agent v2 only)
error	string enum		Error container, see Error Description
substate	string		Extended order status
queuePosition	string		Extended property: kiosk e-queue number (may not be present if there is no such extended property)
- rejectingReason.code	string		Cancellation code
- rejectingReason.message	string		Reason for order cancellation
discountIds	array		Discounts
- id	int	+	Discount ID
- value	decimal		Discount value. Amount or percentage. Accepts negative values.
queuePosition	string?	-	The queue number generated by RK7. WSA 2.7.7.1, RK7 7.06.05.459. It is formed according to the rule: the cash register code is transmitted as a Latin letter + the last digits of the order number.
payMethod	string?	-	Payment method. Starting from WSA 2.8.2.1