List products

GET

products

List products

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

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

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

	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/menu/products")

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,
  "page": 123,
  "pagesize": 123,
  "total_count": 123,
  "more": true,
  "error": "<string>",
  "message": "<string>",
  "products": [
    {
      "uid": "<string>",
      "category_uid": "<string>",
      "name": "<string>",
      "ingredients": "<string>",
      "price": 123,
      "prices_table": {},
      "image": "<string>",
      "allergens": [
        "<string>"
      ],
      "symbols": [
        "<string>"
      ],
      "suggested": true,
      "price_sale_alert": true,
      "price_sale_badge": 123,
      "checkout_selling": true,
      "url": "<string>",
      "hidden": true,
      "position": 123,
      "subrestaurant_uids": [
        "<string>"
      ],
      "ext_id": "<string>",
      "inherits_options": "sync",
      "options": [
        {
          "uid": "<string>",
          "name": "<string>",
          "short_name": "<string>",
          "type": "single",
          "min_selectable": 123,
          "max_selectable": 123,
          "max_quantity": 123,
          "note": "<string>",
          "hidden": true,
          "position": 123,
          "primary": true,
          "first_default": true,
          "show_caption": true,
          "print_caption": true,
          "subrestaurant_uids": [
            "<string>"
          ],
          "ext_id": "<string>",
          "option_values": [
            {
              "uid": "<string>",
              "name": "<string>",
              "short_name": "<string>",
              "price_operator": "+",
              "price_operand": 123,
              "hidden": true,
              "position": 123,
              "checked_default": true,
              "subrestaurant_uids": [
                "<string>"
              ],
              "restrict_to_primary_value_uids": [
                "<string>"
              ],
              "primary_dependent_prices": [
                {
                  "primary_value_uid": "<string>",
                  "price_operator": "+",
                  "price_operand": 123
                }
              ],
              "ext_id": "<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

Unique restaurant identifier (not required with X-Client-Id authentication). Use this to get all products for a restaurant.

catuid

string

Category unique identifier. Use this to get products for a specific category.

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

visible

enum<integer>

default:1

Filter for visible products only (0 = all, 1 = only non-hidden products)

Available options:

0,

1

string

Search query to filter products by name (supports multi-word search)

Response

Products list response

success

boolean

required

Operation result: true if successful, false if failed

page

integer

required

Current page number

pagesize

integer

required

Maximum number of items per page

total_count

integer

required

Total number of results available

boolean

required

Indicates if there are more pages available

error

string

Error code if the operation failed.

See Error codes for general error codes that may occur.

message

string

Human-readable error description if the operation failed

products

object[]

List of products

Show child attributes

List products

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

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

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

	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/menu/products")

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,
  "page": 123,
  "pagesize": 123,
  "total_count": 123,
  "more": true,
  "error": "<string>",
  "message": "<string>",
  "products": [
    {
      "uid": "<string>",
      "category_uid": "<string>",
      "name": "<string>",
      "ingredients": "<string>",
      "price": 123,
      "prices_table": {},
      "image": "<string>",
      "allergens": [
        "<string>"
      ],
      "symbols": [
        "<string>"
      ],
      "suggested": true,
      "price_sale_alert": true,
      "price_sale_badge": 123,
      "checkout_selling": true,
      "url": "<string>",
      "hidden": true,
      "position": 123,
      "subrestaurant_uids": [
        "<string>"
      ],
      "ext_id": "<string>",
      "inherits_options": "sync",
      "options": [
        {
          "uid": "<string>",
          "name": "<string>",
          "short_name": "<string>",
          "type": "single",
          "min_selectable": 123,
          "max_selectable": 123,
          "max_quantity": 123,
          "note": "<string>",
          "hidden": true,
          "position": 123,
          "primary": true,
          "first_default": true,
          "show_caption": true,
          "print_caption": true,
          "subrestaurant_uids": [
            "<string>"
          ],
          "ext_id": "<string>",
          "option_values": [
            {
              "uid": "<string>",
              "name": "<string>",
              "short_name": "<string>",
              "price_operator": "+",
              "price_operand": 123,
              "hidden": true,
              "position": 123,
              "checked_default": true,
              "subrestaurant_uids": [
                "<string>"
              ],
              "restrict_to_primary_value_uids": [
                "<string>"
              ],
              "primary_dependent_prices": [
                {
                  "primary_value_uid": "<string>",
                  "price_operator": "+",
                  "price_operand": 123
                }
              ],
              "ext_id": "<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