Vai al contenuto principale
POST
/
order
/
validate_address
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>"
}
'
{
  "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
  }
}
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

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

​
message
string

Descrizione leggibile dell'errore se l'operazione è fallita

​
data
object

Dati indirizzo validato (presente solo se success = true)