GetOrderState

Purpose	Get order status
Request type	asynchronous/synchronous
Supported agent version	v1, v2
PluggetSystemType	RKMid

Request format

{
  "taskType": "GetOrderState",
  "params": {
    "async": {
      "objectId": number,
       "timeout": number
    },
    "sync": {
      "objectId": number,
       "timeout": number
    },
    "orderGuid": "string",
    "taskGuid": "string"
  }
}

Parameter	Type	Mandatory	Description
taskType		+	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	guid	+	guid of the order whose status you want to get (either orderGuid or taskGuid)
taskGuid	guid		whiteserver task guid for creating an order (either orderGuid or taskGuid)

Response format

{
   "responseCommon":{
      "taskGuid":"guid",
      "taskType":"GetOrderState",
      "objectId":0
   },
   "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, see error description

Asynchronous response format

// Successful response
{
  "taskResponse": {
     "order": {
        "orderGuid": "string",
        "status": {
           "value": "string",
           "isBillPrinted": false
        },
        "substate": "string",
        "rejectingReason": {
            "code": "string",
            "message": "string"
        }
   },
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "GetOrderState",
    "objectId": 0
  },
  "error": {
    "wsError": {
      "code": "string",
      "extCode": "string",
      "desc": "string"
    },
    "agentError": {
      "code": "string",
      "desc": "string"
    }
  }
}

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

Parameter	Parameter type	Mandatory	Description
taskGuid	uuid	+	Request ID
order
- taskGuid	guid		taskGuid whiteserver task to create an order
- orderGuid	guid		Order Guid in RK
status
– value	string		Order status, possible options: Created - new order; Canceled - cancelled; Complited - the order has been paid and is closed from editing; Cooking - the order has been sent to the kitchen Ready - the order is ready for pickup; IssuedOut - the order has been handed over (to the client or the courier). *Agent V1 differences: Unknown - order not found; Created - new order; Accepted - order accepted; Canceled - cancelled by external command while waiting for order confirmation from cashier;
– isBillPrinted	bool		Mark indicating whether the guest bil has been printed.
error	string enum		Error container, see error description
substate	string		Extended order status
- rejectingReason.code			Cancellation code
- rejectingReason.message	string		Reason for order cancellation