Skip to main content
GET
/
customerstats
/
customer
Single customer
curl --request GET \
  --url https://app.xmenu.it/api/customerstats/customer \
  --header 'X-Api-Key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "message": "<string>",
  "customer": {
    "email": "<string>",
    "uid": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone": "<string>",
    "address": "<string>",
    "number": "<string>",
    "city": "<string>",
    "province": "<string>",
    "zip": "<string>",
    "country": "<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>",
    "signedup": true,
    "signup_uid": "<string>",
    "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

​
email
string

Customer email address (alternative to uid)

​
uid
string

Customer unique identifier (alternative to email)

Response

Single customer response

​
success
boolean
required

Operation status:

  • false = Error
  • true = Success
​
error
string

Error code if the operation failed. Possible values:

  • CUSTOMER_NOT_FOUND = Customer not found

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

​
message
string

Textual error description if the operation failed

​
customer
object

Customer object