Order consultation
Orders list
Retrieves a paginated list of restaurant orders. Orders can be filtered by date range.
GET
/
orders
/
list
Orders list
curl --request GET \
--url https://app.xmenu.it/api/orders/list \
--header 'X-Api-Key: <api-key>'import requests
url = "https://app.xmenu.it/api/orders/list"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://app.xmenu.it/api/orders/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.xmenu.it/api/orders/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.xmenu.it/api/orders/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.xmenu.it/api/orders/list")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.xmenu.it/api/orders/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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>",
"values": [
{
"uid": "<string>",
"name": "<string>",
"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>"
}
],
"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>"
}
},
"coupon": {
"code": "<string>",
"description": "<string>",
"discount": 123,
"auto": true
},
"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
apiKeyclientId & clientSecretoauth2
Restaurant API Key. Can be obtained from Tools > API Access in the xMenu dashboard.
Query Parameters
Restaurant unique identifier (not required with X-Client-Id authentication)
Page number to retrieve
Required range:
x >= 1Number of results per page (default: 100, maximum: 100)
Required range:
1 <= x <= 100Orders from specified date (format: YYYY-MM-dd)
Orders until specified date (format: YYYY-MM-dd)
Response
Orders list retrieved successfully
Operation result: true if successful, false if failed
Error code if the operation failed.
See Error codes for general error codes that may also occur.
Human-readable error description if the operation failed
Current page number (1-n)
Maximum number of elements per page
Total count of results
false = last page; true = more results exist
Array of order objects
Show child attributes
Show child attributes
Previous
Single orderRetrieves complete details of a specific single order using its unique identifier.
Next
⌘I
Orders list
curl --request GET \
--url https://app.xmenu.it/api/orders/list \
--header 'X-Api-Key: <api-key>'import requests
url = "https://app.xmenu.it/api/orders/list"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://app.xmenu.it/api/orders/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.xmenu.it/api/orders/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.xmenu.it/api/orders/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.xmenu.it/api/orders/list")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.xmenu.it/api/orders/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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>",
"values": [
{
"uid": "<string>",
"name": "<string>",
"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>"
}
],
"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>"
}
},
"coupon": {
"code": "<string>",
"description": "<string>",
"discount": 123,
"auto": true
},
"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
}
}
]
}