Listar Estados

Descripción

Retorna todos los estados del país asociado al usuario autenticado. Además de la información del estado (ID, nombre y abreviatura), la respuesta incluye la jerarquía completa de ciudades pertenecientes a cada estado y, dentro de cada ciudad, la lista de barrios. Este endpoint puede ser útil para registros, filtros y cualquier funcionalidad que requiera datos geográficos estructurados.

OBS. Disponible para uso con clave de acceso de sucursal y también con clave de acceso de ADM General.

🔑 Parámetros de Consulta

No requiere parámetros. La lista de estados se retorna automáticamente según el país del usuario autenticado.

📤 Estructura de la Respuesta

La respuesta retorna la lista de estados, incluyendo la jerarquía completa de ciudades y barrios asociados.

Campo	Tipo	Descripción
idState	int32	Identificador del estado.
name	string	Nombre del estado.
abbreviation	string	Abreviatura del estado (ej.: `SP`, `RJ`).
idCountry	int32	Identificador del país al que pertenece el estado.
cities	array/object	Lista de ciudades pertenecientes al estado. Ver estructura abajo.

🧩 Estructura del objeto `cities`

Campo	Tipo	Descripción
idCity	int32	Identificador de la ciudad.
idState	int32	Identificador del estado al que pertenece la ciudad.
name	string	Nombre de la ciudad.
neighborhoods	array/object	Lista de barrios pertenecientes a la ciudad. Ver estructura abajo.

🧩 Estructura del objeto `neighborhoods`

Campo	Tipo	Descripción
idNeighborhood	int32	Identificador del barrio.
idCity	int32	Identificador de la ciudad a la que pertenece el barrio.
description	string	Nombre o descripción del barrio.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Respostas

🟢200OK

application/json

Success

Body

Exemplo

[
    {
        "idState": 0,
        "name": "string",
        "abbreviation": "string",
        "idCountry": 0,
        "cities": [
            {
                "idCity": 0,
                "idState": 0,
                "name": "string",
                "neighborhoods": [
                    {
                        "idNeighborhood": 0,
                        "idCity": 0,
                        "description": "string"
                    }
                ]
            }
        ]
    }
]

🟠400Bad Request

Get all states for the current user's country

Listar Estados

Descripción

🔑 Parámetros de Consulta

📤 Estructura de la Respuesta

🧩 Estructura del objeto `cities`

🧩 Estructura del objeto `neighborhoods`

Requisição

Exemplos de Requisição

Respostas

Get all states for the current user's country

Listar Estados#

Descripción#

🔑 Parámetros de Consulta#

📤 Estructura de la Respuesta#

🧩 Estructura del objeto cities#

🧩 Estructura del objeto neighborhoods#

Requisição

Exemplos de Requisição

Respostas

Listar Estados

Descripción

🔑 Parámetros de Consulta

📤 Estructura de la Respuesta

🧩 Estructura del objeto `cities`

🧩 Estructura del objeto `neighborhoods`