Delivery address validation

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

Authorizations

X-Client-Id

string

header

required

Client ID for API Client authentication (must be used together with Client Secret)

X-Client-Secret

string

header

required

Client Secret for API Client authentication (must be used together with Client ID)

Body

application/json

The address can be provided in two alternative ways:

Mode 1: address field with complete address as a single string
Mode 2: separate fields (street, number, city, province, zip, country)

You must provide the address using one of the two modes.

address

string

[Mode 1] Complete address as a single string (alternative to separate fields)

street

string

[Mode 2] Street/avenue name

number

string

[Mode 2] Civic number

city

string

[Mode 2] Municipality

province

string

[Mode 2] Province code

zip

string

[Mode 2] Postal code

country

string

[Mode 2] Country code (e.g., IT)

language

string

ISO 639-1 language code; defaults to restaurant settings

Response

Address validation response

success

boolean

required

Operation result: true if successful, false if failed

error

string

Error code if the operation failed. Possible values:

INVALID_ADDRESS = invalid, incomplete or not found address
ADDRESS_NOT_SERVED = address outside service zone
DELIVERY_NOT_AVAILABLE = delivery service unavailable

See Error codes for general error codes that may occur.

message

string

Human-readable error description if the operation failed

data

object

Validated address data (present only if success = true)

Show child attributes

Pickup / delivery timesRetrieval of available times for pickup at the location or home delivery

Delivery address validation

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
  }
}

Overview

Notifications

Order actions

Coupon actions

Account info

Menu consultation

Menu import

Customer registry

Order consultation

Order insertion

Push notifications (single send)

Push notifications

Delivery address validation

Authorizations

Body

Response