OrderStatusChanged

The OrderStatusChanged event occurs when an existing order has a status change, substatus change, or a reason for cancellation.

Body format

JSON

{
   "responseEventCommon":{
      "objectId":199990160,
      "agentGuid":"a63d8b95-8ea0-d83c-8db3-eac3692bcbf2",
      "eventGuid":"31ee5577-5e75-4b5c-bad3-b650e5acb16f",
      "dateTimeServerReceiveEventFromAgent":"2020-12-11T11:36:51.7032158+03:00",
      "eventType":"OrderStatusChanged"
   },
   "response":{
      "originalOrderId":"",
      "orderGuid":"5e964af3-6e1d-4661-4db1-08d897c7079a",
      "status":{
         "value":"Complited",
         "isBillPrinted":true
      },
      "substate": "string",
      "rejectingReason": {
        "code": "string",
        "message": "string"
      }
}

Description

Parameter	Type	Mandatory	Description
responseEventCommon
objectId	int	yes	Restaurant code in the licensing system
agentGuid	guid	yes	Restaurant Agent ID
eventGuid	guid	yes	Unique event identifier generated by the agent
dateTimeServerReceiveEventFromAgent	string dateTime	yes	Date and time of receiving the White Server event from the agent. The time of sending the event to the aggregator by callback may differ and be slightly longer
eventType	string enum	yes	Event type, options available: OrderStatusChanged
response
originalOrderId	string		External order identifier
orderGuid	guid		Order ID from the cash register
status.value	string		Order status
status.isBillPrinted	bool		Mark indicating whether a guest bill was printed
substate	string		Extended order status
rejectingReason.code	string		Cancellation code
rejectingReason.message	string		Reason for order cancellation

In a multi-agent, an arbitrary refusal reason with code 0 and text entered by the user can be used.