Validazione indirizzo consegna

POST

order

validate_address

curl --request POST \
  --url https://app.xmenu.it/api/order/validate_address \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "address": "<string>",
  "street": "<string>",
  "number": "<string>",
  "city": "<string>",
  "province": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "language": "<string>"
}
'

import requests

url = "https://app.xmenu.it/api/order/validate_address"

payload = {
    "address": "<string>",
    "street": "<string>",
    "number": "<string>",
    "city": "<string>",
    "province": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "language": "<string>"
}
headers = {
    "X-Client-Id": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-Id': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    address: '<string>',
    street: '<string>',
    number: '<string>',
    city: '<string>',
    province: '<string>',
    zip: '<string>',
    country: '<string>',
    language: '<string>'
  })
};

fetch('https://app.xmenu.it/api/order/validate_address', 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/order/validate_address",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'address' => '<string>',
    'street' => '<string>',
    'number' => '<string>',
    'city' => '<string>',
    'province' => '<string>',
    'zip' => '<string>',
    'country' => '<string>',
    'language' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Client-Id: <api-key>",
    "X-Client-Secret: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.xmenu.it/api/order/validate_address"

	payload := strings.NewReader("{\n  \"address\": \"<string>\",\n  \"street\": \"<string>\",\n  \"number\": \"<string>\",\n  \"city\": \"<string>\",\n  \"province\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"language\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Client-Id", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.xmenu.it/api/order/validate_address")
  .header("X-Client-Id", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"<string>\",\n  \"street\": \"<string>\",\n  \"number\": \"<string>\",\n  \"city\": \"<string>\",\n  \"province\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"language\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.xmenu.it/api/order/validate_address")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"<string>\",\n  \"street\": \"<string>\",\n  \"number\": \"<string>\",\n  \"city\": \"<string>\",\n  \"province\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"language\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "error": "<string>",
  "message": "<string>",
  "data": {
    "address": {
      "place_id": "<string>",
      "street": "<string>",
      "number": "<string>",
      "city": "<string>",
      "province": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "lat": 123,
      "lng": 123
    },
    "subrestaurant_uid": "<string>",
    "kms": 123,
    "delivery_fee": 123,
    "order_min": 123
  }
}

write:orders

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

L'indirizzo può essere fornito in due modalità alternative:

Modalità 1: campo address con indirizzo completo come stringa unica
Modalità 2: campi separati (street, number, city, province, zip, country)

È necessario fornire l'indirizzo in una delle due modalità.

address

string

[Modalità 1] Indirizzo completo come stringa unica (alternativa ai campi separati)

street

string

[Modalità 2] Nome della via/viale

number

string

[Modalità 2] Numero civico

city

string

[Modalità 2] Comune

province

string

[Modalità 2] Codice provincia

zip

string

[Modalità 2] Codice postale

country

string

[Modalità 2] Codice paese (es. IT)

language

string

Codice lingua ISO 639-1; di default viene utilizzato quello impostato nelle impostazioni del ristorante

Risposta

Risposta validazione indirizzo

success

boolean

obbligatorio

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

error

string

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

INVALID_ADDRESS = indirizzo non valido, incompleto o non trovato
ADDRESS_NOT_SERVED = indirizzo fuori dalla zona di servizio
DELIVERY_NOT_AVAILABLE = servizio di consegna non disponibile
MISSING_PARAMETER = parametri dell'indirizzo mancanti o non sufficienti a identificare l'indirizzo (non è stato fornito né address né la combinazione street + city + number, oppure i campi forniti non bastano)
EXTERNAL_SERVICE_ERROR = il servizio esterno di geocodifica/calcolo distanze è temporaneamente non disponibile

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

message

string

Descrizione leggibile dell'errore se l'operazione è fallita

data

object

Dati indirizzo validato (presente solo se success = true)

Show child attributes

Validazione indirizzo consegna

curl --request POST \
  --url https://app.xmenu.it/api/order/validate_address \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Id: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --data '
{
  "address": "<string>",
  "street": "<string>",
  "number": "<string>",
  "city": "<string>",
  "province": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "language": "<string>"
}
'

import requests

url = "https://app.xmenu.it/api/order/validate_address"

payload = {
    "address": "<string>",
    "street": "<string>",
    "number": "<string>",
    "city": "<string>",
    "province": "<string>",
    "zip": "<string>",
    "country": "<string>",
    "language": "<string>"
}
headers = {
    "X-Client-Id": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-Id': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    address: '<string>',
    street: '<string>',
    number: '<string>',
    city: '<string>',
    province: '<string>',
    zip: '<string>',
    country: '<string>',
    language: '<string>'
  })
};

fetch('https://app.xmenu.it/api/order/validate_address', 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/order/validate_address",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'address' => '<string>',
    'street' => '<string>',
    'number' => '<string>',
    'city' => '<string>',
    'province' => '<string>',
    'zip' => '<string>',
    'country' => '<string>',
    'language' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Client-Id: <api-key>",
    "X-Client-Secret: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.xmenu.it/api/order/validate_address"

	payload := strings.NewReader("{\n  \"address\": \"<string>\",\n  \"street\": \"<string>\",\n  \"number\": \"<string>\",\n  \"city\": \"<string>\",\n  \"province\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"language\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Client-Id", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.xmenu.it/api/order/validate_address")
  .header("X-Client-Id", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"<string>\",\n  \"street\": \"<string>\",\n  \"number\": \"<string>\",\n  \"city\": \"<string>\",\n  \"province\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"language\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.xmenu.it/api/order/validate_address")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"<string>\",\n  \"street\": \"<string>\",\n  \"number\": \"<string>\",\n  \"city\": \"<string>\",\n  \"province\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"country\": \"<string>\",\n  \"language\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "error": "<string>",
  "message": "<string>",
  "data": {
    "address": {
      "place_id": "<string>",
      "street": "<string>",
      "number": "<string>",
      "city": "<string>",
      "province": "<string>",
      "zip": "<string>",
      "country": "<string>",
      "lat": 123,
      "lng": 123
    },
    "subrestaurant_uid": "<string>",
    "kms": 123,
    "delivery_fee": 123,
    "order_min": 123
  }
}

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

Validazione indirizzo consegna

Autorizzazioni

Corpo

Risposta