Skip to main content
GET
/
orders
/
list
Orders list
curl --request GET \
  --url https://app.xmenu.it/api/orders/list \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "message": "<string>",
  "page": 123,
  "pagesize": 123,
  "total_count": 123,
  "more": true,
  "orders": [
    {
      "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",
      "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>"
        },
        "fee": 123,
        "date_iso": "2023-11-07T05:31:56Z",
        "deliverypoint": {
          "name": "<string>",
          "full_address": "<string>"
        }
      },
      "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)

​
page
integer
required

Page number to retrieve

Required range: x >= 1
​
pagesize
integer
default:100

Number of results per page (default: 100, maximum: 100)

Required range: 1 <= x <= 100
​
date_from
string<date>

Orders from specified date (format: YYYY-MM-dd)

​
date_to
string<date>

Orders until specified date (format: YYYY-MM-dd)

Response

Orders list retrieved successfully

​
success
boolean
required

Operation result: true if successful, false if failed

​
error
string

Error code if the operation failed.

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

​
message
string

Human-readable error description if the operation failed

​
page
integer

Current page number (1-n)

​
pagesize
integer

Maximum number of elements per page

​
total_count
integer

Total count of results

​
more
boolean

false = last page; true = more results exist

​
orders
object[]

Array of order objects