API do Demander - Cidades

Este artigo faz parte da documentação da API de Integração REST.

Documentação para consultar, inserir, atualizar e excluir cidades.

Consulta

Lista as cidades da empresa. Sem filtro, considera dataAlteracao dos últimos 6 meses.

Rota: {host}/public/v1/cidades?pagina={pagina}&limite={limite}&filtroDataAlteracao={data}&operadorFiltro={operador}
Método: GET

Retorno:

{
  "cidades": [
    {
      "codigo": 54,
      "descricao": "LAJEADO",
      "uf": "RS",
      "codigoPais": "BR",
      "ativo": 1,
      "dataAlteracao": "2026-07-24 10:00:00"
    }
  ]
}

Inserir ou atualizar

POST upsert pela chave codigo.

Rota: {host}/public/v1/cidades
Método: POST
Body: json

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
codigo	int		✓	Código da cidade. Identificador único usado para inserir ou atualizar (upsert).
descricao	string	100	✓	Nome da cidade.
uf	string	2	✓	UF do estado (ex.: `RS`).
codigoPais	string	2		Código ISO-2 do país. Padrão na inclusão: `BR`.
ativo	int			Valores: `0` ou `1`. Padrão na inclusão: `1`.

Body:

{
  "codigo": 54,
  "descricao": "LAJEADO",
  "uf": "RS",
  "codigoPais": "BR",
  "ativo": 1
}

Retorno:

{
  "codigo": 54,
  "descricao": "LAJEADO",
  "uf": "RS",
  "codigoPais": "BR",
  "ativo": 1,
  "dataAlteracao": "2026-07-24 10:00:00"
}

Excluir

Remove a cidade.

Rota: {host}/public/v1/cidades?codigo={codigo}
Método: DELETE

Retorno:

{
  "mensagem": "Registro excluído com sucesso."
}

Criar todas as cidades do IBGE

Copia as cidades do IBGE para a empresa, com codigoPais = BR.

Rota: {host}/public/v1/cidades/criar-todas-cidades-do-ibge
Método: POST

Retorno:

{
  "mensagem": "Cidades do IBGE criadas com sucesso.",
  "quantidadeInserida": 5570
}