Alertas de estoque

Índice de endpoints · Modelos

API-001 — Consultar alertas de estoque

POST /api/alertas-estoque

Finalidade: Consultar alertas de estoque.

Fonte: src/main/java/com/wester/storage/controller/AlertaEstoqueController.java:37 — AlertaEstoqueController.consultarAlertas.

Autenticação, autorização e perfis: hasAuthority('SCREEN_ALERTS') Consulte a correspondência entre autoridades e perfis em Autenticação.

Headers: Authorization: Bearer <TOKEN>. Accept: application/json recomendado. Content-Type: application/json para o corpo.

Parâmetros:

Sem query parameters, path variables ou headers de negócio declarados.

Corpo da requisição: AlertaEstoqueFiltroDTO; opcional. Sem @Valid no argumento; validações de negócio são executadas pelo serviço. Consulte os campos e restrições em Modelos.

Exemplo sintético (IDs devem existir e versões devem vir de consulta):

{
  "tipoAlerta": "Exemplo",
  "produtoId": 1,
  "textoLivre": "Exemplo",
  "codigoWester": "Exemplo",
  "areaId": 1,
  "criticidade": "Exemplo",
  "produtoAtivo": false,
  "diasSemMovimentacao": 1,
  "ordenarPor": "Exemplo",
  "direcaoOrdenacao": "Exemplo",
  "pagina": 1,
  "tamanhoPagina": 1
}

Resposta de sucesso: AlertaEstoqueResponseDTO. Campos em Modelos.

Exemplo estrutural sintético, sem afirmar valores de produção:

{
  "itens": [],
  "pagina": 1,
  "tamanhoPagina": 1,
  "totalItens": 1,
  "totalPaginas": 1,
  "resumo": {
    "totalAlertas": 1,
    "produtosSemEstoque": 1,
    "produtosAbaixoMinimo": 1,
    "produtosAcimaMaximo": 1,
    "produtosSemMovimentacao": 1,
    "criticidadeAlta": 1,
    "criticidadeMedia": 1,
    "criticidadeBaixa": 1
  }
}

Códigos HTTP: 200, 401, 403. Códigos de segurança dependem da cadeia de filtros; falhas não capturadas podem chegar ao tratamento global descrito em Erros.

Regras de negócio e dependências: AlertaEstoqueService.consultarAlertas. Consulte documento interno de regras de negócio para efeitos persistentes e validações compartilhadas.

cURL (Bash):

curl -X POST "${BASE_URL}/api/alertas-estoque" -H "Authorization: Bearer ${TOKEN}" -H 'Content-Type: application/json' --data '{"tipoAlerta":"Exemplo","produtoId":1,"textoLivre":"Exemplo","codigoWester":"Exemplo","areaId":1,"criticidade":"Exemplo","produtoAtivo":false,"diasSemMovimentacao":1,"ordenarPor":"Exemplo","direcaoOrdenacao":"Exemplo","pagina":1,"tamanhoPagina":1}'