Elenco clienti

GET

customerstats

customers

Elenco clienti

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>"
    }
  ]
}

Autorizzazioni

X-Api-Key

string

header

obbligatorio

Chiave API del ristorante. Può essere ottenuta da Strumenti > Accesso API nella dashboard xMenu.

Parametri della query

restuid

string

obbligatorio

Identificativo univoco del ristorante

page

integer

obbligatorio

Numero di pagina da recuperare

Intervallo richiesto: x >= 1

pagesize

integer

predefinito:100

Numero di risultati per pagina (max: 100)

Intervallo richiesto: 1 <= x <= 100

added_from

string<date>

Filtra clienti aggiunti da questa data (formato YYYY-MM-dd)

added_to

string<date>

Filtra clienti aggiunti fino a questa data (formato YYYY-MM-dd)

signedup

enum<string>

Filtra per stato di registrazione

0 = clienti non registrati
1 = clienti registrati

Opzioni disponibili:

0,

1

first_order_from

string<date>

Filtra clienti con primo ordine da questa data (formato YYYY-MM-dd)

first_order_to

string<date>

Filtra clienti con primo ordine fino a questa data (formato YYYY-MM-dd)

devices_unregistered_from

string<date>

Filtra clienti con più recente disinstallazione app da questa data

devices_unregistered_to

string<date>

Filtra clienti con più recente disinstallazione app fino a questa data

Filtra clienti con account eliminato da questa data (formato YYYY-MM-dd)

Filtra clienti con account eliminato fino a questa data (formato YYYY-MM-dd)

Risposta

Risposta elenco clienti

success

boolean

obbligatorio

Stato dell'operazione:

false = Errore
true = Successo

error

string

Codice errore se l'operazione è fallita.

Vedi Codici di errore per i codici di errore generali che possono verificarsi.

message

string

Descrizione testuale dell'errore se l'operazione è fallita

page

integer

Numero pagina corrente

pagesize

integer

Numero massimo di elementi per pagina

total_count

integer

Numero totale di risultati

boolean

Se ci sono ulteriori risultati:

false = Nessun altro risultato
true = Altri risultati disponibili

customers

object[]

Array di oggetti cliente

Show child attributes

Elenco clienti

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>"
    }
  ]
}

Panoramica

Notifiche ordini

Notifiche menu

Notifiche clienti

Azioni ordine

Azioni coupon

Info account

Consultazione menu

Importazione menu

Anagrafica clienti

Consultazione ordini

Inserimento ordine

Notifiche push (singolo invio)

Notifiche push

Autorizzazioni

Parametri della query

Risposta