API do Demander - Segmentos

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

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

Consulta

Lista os segmentos da empresa. Sem filtro, considera dataAlteracao dos últimos 6 meses.

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

Retorno:

{
  "segmentos": [
    {
      "codigo": "1",
      "descricao": "Vestuário",
      "ativo": 1,
      "dataAlteracao": "2026-07-15 10:00:00"
    }
  ]
}

Inserir ou atualizar

POST upsert pela chave codigo.

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

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
codigo	string	20	✓	Código do segmento. Identificador único usado para inserir ou atualizar (upsert).
descricao	string	255	✓	Nome do segmento.
ativo	int			Valores: `0` ou `1`. Padrão na inclusão: `1`.

Body:

{
  "codigo": "1",
  "descricao": "Vestuário",
  "ativo": 1
}

Retorno:

{
  "codigo": "1",
  "descricao": "Vestuário",
  "ativo": 1,
  "dataAlteracao": "2026-07-15 10:00:00"
}

Excluir

Remove o segmento.

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

Retorno:

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