Elenca i paesi e gli stati supportati

Restituisce il catalogo completo dei paesi e delle relative suddivisioni (stati, province, territori) supportati da Listings API per i dati delle sedi. Ogni voce relativa a un paese contiene il codice ISO (iso), un id Relay, un databaseId numerico, un array states e tre flag che indicano come viene verificato l'indirizzo di una sede in quel paese. Ogni stato contiene il proprio iso e un id numerico. Per i paesi che Listings API non suddivide viene restituito un array states vuoto.

Regole per gli indirizzi per paese

postalCode è facoltativo in tutti i paesi, ma invialo ogni volta che hasPostalCode è true: alcune piattaforme di pubblicazione ne hanno bisogno per posizionare il segnaposto sulla mappa. Se invii un valore, viene verificato rispetto al formato del paese (SY10014). Con hideAddress: true sulla sede, le verifiche della città e dello stato vengono saltate.

Caso d'uso: popolare i menu a discesa dell'indirizzo. Recupera questi dati una sola volta all'avvio dell'app e memorizzali nella cache. Genera il selettore del paese a partire da name/iso e, quando viene scelto un paese, popola il selettore dello stato a partire da states di quel paese. I valori di iso vengono usati direttamente nei campi countryIso e stateIso degli endpoint create-location e update-location.

Caso d'uso: convalidare un indirizzo prima di inviarlo. Prima di chiamare create-location, verifica che il valore di countryIso desiderato esista in questo elenco, che stateIso compaia tra i valori di quel paese quando stateRequired è true e che city sia impostato quando hasCity è true. Rilevare qui un codice non supportato permette di mostrare un messaggio chiaro lato client anziché ricevere 400 dalla chiamata di creazione. La risposta completa è di grandi dimensioni (include tutti i paesi supportati); l'esempio qui sopra è ridotto a una sola voce. Non ci sono parametri di query; l'endpoint restituisce sempre l'insieme completo.