CompleteOrder

Purpose	Completes the order if the prepayment made is equal to the order amount. After executing this command, the paid order becomes unavailable for editing.
Request type	asynchronous/synchronous
Supported agent version	v2
PluggetSystemType	RKMid

Request format

JSON

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

Parameter	Type	Mandatory	Description
taskType	string	yes	Task type
-async			Asynchronous method call: either synchronous or asynchronous
-sync			Synchronous method call: either synchronous or asynchronous
--timeout	int	no	Agent response timeout in seconds, default is 120 seconds
--objectId	int	yes	Restaurant code in the licensing system
-orderGuid	guid	yes	Guid of the order for which payment is required

Synchronous response format

JSON

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

Parameter	Type	Description
-taskGuid	guid	Unique code of this task, used when receiving a task through 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

Asynchronous response format

// A successful response means that the paid order has been verified and completed; it cannot be changed now.
{
  "taskResponse": {
     "order": {
        "price": {
           "total": number,
        }
     }
  },
  "responseCommon": {
    "taskGuid": "string",
    "taskType": "CompleteOrder",
    "objectId": number
  }
}

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

Parameter

Parameter type

Mandatory

Description

order

yes

price.total

money

yes

Total cost of the order

error

string enum

Error container, for more details see the article Error Description

-wsError

string enum

Whiteserver Error

--code

string

Error code

--desc

string

Error description

-agentError

string enum

Error from agent

--code

string

In addition to the existing ones, the following error codes will appear (in numbers in the old agent):

value	description
OrderIsLocked	the order is blocked
OrderIsClosed	the order is closed
PaymentIsMoreThanTotalPrice	payment transferred is more than the order value

--desc

string

Error description