API de demandante: segmentos

Este artículo es parte de la documentación API de integración REST.

Documentación para consultar, insertar, actualizar y eliminar segmentos.

Consulta

Enumere los segmentos de la empresa. Sin filtro, considera dataAlteracao de los ú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"
    }
  ]
}

Insertar o actualizar

POST inserción mediante la tecla codigo.

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

Propiedad	Tipo	Tamaño	Obligatorio	Descripción
código	cadena	20	✓	Código de segmento. Identificador único utilizado para insertar o actualizar (upsert).
descripción	cadena	255	✓	Nombre del segmento.
activo	entero			Valores: `0` o `1`. Valor predeterminado de inclusión: `1`.

Cuerpo:

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

Retorno:

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

Eliminar

Elimina el segmento.

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

Retorno:

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