Vai al contenuto principale
POST
/
menu
/
import
Importazione menu
curl --request POST \
  --url https://app.xmenu.it/api/menu/import \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "pos_uid": "<string>",
  "update_mode": "replace",
  "categories": [
    {
      "ext_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "image": "<string>",
      "hidden": true,
      "position": 123,
      "options": [
        {
          "ext_id": "<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,
          "option_values": [
            {
              "ext_id": "<string>",
              "name": "<string>",
              "short_name": "<string>",
              "price_operator": "+",
              "price_operand": 123,
              "hidden": true,
              "checked_default": true,
              "position": 123
            }
          ]
        }
      ]
    }
  ],
  "products": [
    {
      "ext_id": "<string>",
      "category_ext_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "price": 123,
      "prices_table": {},
      "image": "<string>",
      "hidden": true,
      "position": 123,
      "inherits_options": "sync",
      "options": [
        {
          "ext_id": "<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,
          "option_values": [
            {
              "ext_id": "<string>",
              "name": "<string>",
              "short_name": "<string>",
              "price_operator": "+",
              "price_operand": 123,
              "hidden": true,
              "checked_default": true,
              "position": 123
            }
          ]
        }
      ]
    }
  ]
}
'
{
  "success": true,
  "error": "<string>",
  "message": "<string>"
}
write:menu
Ogni entità include il campo ext_id, che deve essere valorizzato con il proprio identificativo univoco.Se non esiste già un elemento della stessa entità con questo ext_id, ne verrà creato uno nuovo. Se invece l’elemento esiste, il suo contenuto verrà aggiornato.L’ambito di univocità di tale ID è interno dell’ambiente definito dal Client ID (X-Client-Id), ovvero lo stesso ext_id importato da Client ID diversi, genererà elementi distinti.Gli ext_id di options e option_values possono essere univoci in tale ambiente o solo all’interno del rispettivo elemento parent (categoria/prodotto per le options, opzione per gli option_values).

Autorizzazioni

​
X-Client-Id
string
header
obbligatorio

Client ID per l'autenticazione API Client (deve essere usato insieme al Client Secret)

​
X-Client-Secret
string
header
obbligatorio

Client Secret per l'autenticazione API Client (deve essere usato insieme al Client ID)

Corpo

application/json
​
pos_uid
string
obbligatorio

Identificatore punto vendita

​
update_mode
enum<string>
obbligatorio

Modalità di aggiornamento:

  • replace = Sostituzione completa
  • merge = Aggiunta di nuovi elementi
Opzioni disponibili:
replace,
merge
​
categories
object[]

Array di categorie. Obbligatorio se update_mode = replace

​
products
object[]

Array di prodotti. Obbligatorio se update_mode = replace

Risposta

Risposta importazione menu

​
success
boolean
obbligatorio

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

​
error
string

Codice errore se l'operazione è fallita. Valori possibili:

  • IMPORT_ERROR = Errore durante l'importazione (consultare il parametro message per i dettagli)

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

​
message
string

Descrizione errore se l'importazione non è andata a buon fine