Customer list

GET

customerstats

customers

Customer list

curl --request GET \
  --url https://app.xmenu.it/api/customerstats/customers \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://app.xmenu.it/api/customerstats/customers', 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/customerstats/customers",
  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/customerstats/customers"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.xmenu.it/api/customerstats/customers")

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,
  "customers": [
    {
      "email": "<string>",
      "uid": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "address": "<string>",
      "number": "<string>",
      "city": "<string>",
      "province": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "invoice_data": {
        "name": "<string>",
        "address": "<string>",
        "city": "<string>",
        "province": "<string>",
        "zip": "<string>",
        "country": "<string>",
        "vat_code": "<string>",
        "tax_code": "<string>",
        "sdi_codice": "<string>",
        "sdi_pec": "<string>"
      },
      "orders_count": 123,
      "pickup_orders_count": 123,
      "delivery_orders_count": 123,
      "offline_orders_count": 123,
      "first_order": "<string>",
      "last_order": "<string>",
      "last_offline_order": "<string>",
      "orders_total": 123,
      "added": "<string>",
      "accept_marketing": true,
      "mobile_app": true,
      "signedup": true,
      "signup_uid": "<string>",
      "birthday": "2023-12-25",
      "loyalty_points": 123,
      "devices_unregistered": "<string>",
      "code": "<string>",
      "subrestaurant_code": "<string>",
      "subrestaurant_uid": "<string>",
      "signup_deleted": "<string>"
    }
  ]
}

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

required

Unique restaurant identifier

page

integer

required

Page number to retrieve

Required range: x >= 1

pagesize

integer

default:100

Number of results per page (max: 100)

Required range: 1 <= x <= 100

added_from

string<date>

Filter customers added from this date (YYYY-MM-dd format)

added_to

string<date>

Filter customers added until this date (YYYY-MM-dd format)

signedup

enum<string>

Filter by registration status

0 = unregistered customers
1 = registered customers

Available options:

0,

1

first_order_from

string<date>

Filter customers with first order from this date (YYYY-MM-dd format)

first_order_to

string<date>

Filter customers with first order until this date (YYYY-MM-dd format)

devices_unregistered_from

string<date>

Filter customers with most recent app uninstall from this date

devices_unregistered_to

string<date>

Filter customers with most recent app uninstall until this date

Filter customers with account deleted from this date (YYYY-MM-dd format)

Filter customers with account deleted until this date (YYYY-MM-dd format)

Response

Customer list response

success

boolean

required

Operation status:

false = Error
true = Success

error

string

Error code if the operation failed.

See Error codes for general error codes that may occur.

message

string

Textual error description if the operation failed

page

integer

Current page number

pagesize

integer

Maximum number of elements per page

total_count

integer

Total number of results

boolean

Whether there are additional results:

false = No more results
true = More results available

customers

object[]

Array of customer objects

Show child attributes

Customer list

curl --request GET \
  --url https://app.xmenu.it/api/customerstats/customers \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://app.xmenu.it/api/customerstats/customers', 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/customerstats/customers",
  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/customerstats/customers"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.xmenu.it/api/customerstats/customers")

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,
  "customers": [
    {
      "email": "<string>",
      "uid": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "address": "<string>",
      "number": "<string>",
      "city": "<string>",
      "province": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "invoice_data": {
        "name": "<string>",
        "address": "<string>",
        "city": "<string>",
        "province": "<string>",
        "zip": "<string>",
        "country": "<string>",
        "vat_code": "<string>",
        "tax_code": "<string>",
        "sdi_codice": "<string>",
        "sdi_pec": "<string>"
      },
      "orders_count": 123,
      "pickup_orders_count": 123,
      "delivery_orders_count": 123,
      "offline_orders_count": 123,
      "first_order": "<string>",
      "last_order": "<string>",
      "last_offline_order": "<string>",
      "orders_total": 123,
      "added": "<string>",
      "accept_marketing": true,
      "mobile_app": true,
      "signedup": true,
      "signup_uid": "<string>",
      "birthday": "2023-12-25",
      "loyalty_points": 123,
      "devices_unregistered": "<string>",
      "code": "<string>",
      "subrestaurant_code": "<string>",
      "subrestaurant_uid": "<string>",
      "signup_deleted": "<string>"
    }
  ]
}

Overview

Order notifications

Menu notifications

Customer notifications

Order actions

Coupon actions

Account info

Menu consultation

Menu import

Customer registry

Order consultation

Order insertion

Push notifications (single send)

Push notifications

Authorizations

Query Parameters

Response