Consultar Localidades

Buscar Países

Para todas as consulta desta seção, será necessário o uso do seu Bearer Token.

Para efetuar a busca por países, execute a consulta via GET na rota Url/geo/countries.

Se a requisição estiver correta, uma resposta do tipo 200 OK será retornada, juntamente com os dados de todos países suportados pela plataforma.

Países

Buscar Estados

Para efetuar a busca por estados, execute a consulta via GET na rota Url/geo/states.

Se a requisição estiver correta, uma resposta do tipo 200 OK será retornada, juntamente com todos os estados atendidos.

Estados

Buscar Estados por País

Caso queira buscar os estados por países, utilize o ID do país desejado, na requisição em Url/geo/countries/{countryId}/states.

Se a requisição estiver correta, uma resposta do tipo 200 OK será retornada, juntamente com uma coleção de estados, classificados por país.

Buscar Cidades

Para efetuar a busca por cidades, execute a consulta via GET na rota Url/geo/cities.

Se a requisição estiver correta, uma resposta do tipo 200 OK será retornada, juntamente com todas as cidades cadastradas.

Cidades

Buscar Cidades por Estados

Caso queira buscar as cidades por estado, utilize o ID do estado desejado, na requisição em Url/geo/states/{cityId}/cities.

Se a requisição estiver correta, uma resposta do tipo 200 OK será retornada, juntamente com uma coleção de cidades, classificadas pelo estado.

Erros: 401 Unauthorized: Verifique se está utilzando um Bearer Token válido e tente novamente. 404 Not Found: Verifique a rota ou o método utilizado e tente novamente. Caso sejam retornados outros erros, favor entrar em contato com o time de integração.