Elenco prodotti

GET

products

Elenco prodotti

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>"
              ],
              "ext_id": "<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

Identificatore univoco ristorante (non necessario con autenticazione via X-Client-Id). Usare questo parametro per ottenere tutti i prodotti di un ristorante.

catuid

string

Identificatore univoco categoria. Usare questo parametro per ottenere i prodotti di una specifica categoria.

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

visible

enum<integer>

predefinito:1

Filtro per soli prodotti visibili (0 = tutti, 1 = solo prodotti non nascosti)

Opzioni disponibili:

0,

1

string

Query di ricerca per filtrare i prodotti per nome (supporta ricerca multi-parola)

Risposta

Risposta con elenco prodotti

success

boolean

obbligatorio

Risultato dell'operazione: true se ha avuto successo, false se fallita

page

integer

obbligatorio

Numero di pagina corrente

pagesize

integer

obbligatorio

Numero massimo di elementi per pagina

total_count

integer

obbligatorio

Numero totale di risultati disponibili

boolean

obbligatorio

Indica se sono disponibili altre pagine

error

string

Codice errore se l'operazione è fallita.

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

message

string

Descrizione leggibile dell'errore se l'operazione è fallita

products

object[]

Elenco prodotti

Show child attributes

Elenco prodotti

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>"
              ],
              "ext_id": "<string>"
            }
          ]
        }
      ]
    }
  ]
}

Panoramica

Notifiche

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