Order closure

Close and archive a completed order

POST /order/close

Close order

cURL

curl --request POST \
  --url https://app.xmenu.it/api/order/close \
  --header 'X-Api-Key: <api-key>'

200

Example

{
  "success": true,
  "error": "<string>",
  "message": "<string>"
}

Authorizations

apiKeyclientId & clientSecretoauth2

X-Api-Key · string · header · required

Restaurant API Key. Can be obtained from Tools > API Access in the xMenu dashboard.

Query Parameters

uid · string · required

Unique order identifier (received via webhook notification)

token · string · required

Order token (received via webhook notification)

Response

200

application/json

Order closure response

success · boolean · required

Operation result: true if successful, false if failed

error · string

Error code if the operation failed. Possible values:

• NOT_FOUND = Order not located in system
• INVALID_TOKEN = Provided token doesn't match order

See Error codes for general error codes that may also occur.

message · string

Human-readable error description if the operation failed