Skip to main content
GET
/
orders
/
get
Single order
curl --request GET \
  --url https://app.xmenu.it/api/orders/get \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "message": "<string>",
  "order": {
    "uid": "<string>",
    "token": "<string>",
    "date": "<string>",
    "date_iso": "2023-11-07T05:31:56Z",
    "number": 123,
    "order_number": "<string>",
    "client": {
      "uid": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "email": "jsmith@example.com"
    },
    "details": [
      {
        "product": {
          "uid": "<string>",
          "name": "<string>",
          "price": 123,
          "category": "<string>",
          "category_uid": "<string>",
          "offline_uid": "<string>",
          "ext_id": "<string>"
        },
        "options": [
          {
            "uid": "<string>",
            "name": "<string>",
            "type": "single",
            "values": [
              {
                "uid": "<string>",
                "name": "<string>",
                "price_operator": "+",
                "price_operand": 123,
                "quantity": 123,
                "offline_uid": "<string>",
                "ext_id": "<string>"
              }
            ],
            "ext_id": "<string>"
          }
        ],
        "price": 123,
        "price_options": 123,
        "quantity": 123,
        "total": 123,
        "free_quantity": 123,
        "notes": "<string>"
      }
    ],
    "dmethod": "0",
    "fee": 123,
    "payment_method": "cash",
    "paid": true,
    "total": 123,
    "currency": "<string>",
    "closed": true,
    "subrestaurant_code": "<string>",
    "subrestaurant_uid": "<string>",
    "notes": "<string>",
    "pickup": {
      "date": "<string>",
      "date_iso": "2023-11-07T05:31:56Z"
    },
    "delivery": {
      "date": "<string>",
      "address": {
        "street": "<string>",
        "number": "<string>",
        "city": "<string>",
        "province": "<string>",
        "zip": "<string>",
        "country": "<string>",
        "place_id": "<string>",
        "lat": 123,
        "lng": 123,
        "kms": 123,
        "doorbell": "<string>",
        "floor": "<string>",
        "quarter": "<string>"
      },
      "date_iso": "2023-11-07T05:31:56Z",
      "deliverypoint": {
        "name": "<string>",
        "full_address": "<string>",
        "fee": 123
      }
    },
    "payment_method_sub": "cash",
    "coupon": {
      "code": "<string>",
      "discount": 123
    },
    "confirmation": {
      "confirmed": true,
      "countdown_time": 123,
      "countdown_started": "<string>",
      "closed": true,
      "date": "<string>",
      "date_iso": "2023-11-07T05:31:56Z",
      "text": "<string>",
      "countdown_started_iso": "2023-11-07T05:31:56Z",
      "countdown_end": "<string>",
      "countdown_end_iso": "2023-11-07T05:31:56Z",
      "timeout": true
    }
  }
}

Authorizations

​
X-Api-Key
string
header
required

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

Query Parameters

​
restuid
string

Restaurant unique identifier (not required with X-Client-Id authentication)

​
uid
string
required

Order ID

Response

Order details retrieved successfully

​
success
boolean
required

Operation result: true if successful, false if failed

​
error
string

Error code if the operation failed. Possible values:

  • ORDER_NOT_FOUND = Order not found

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

​
message
string

Human-readable error description if the operation failed

​
order
object

Order object containing all order details