Consultas de estoque e mapa

Índice de endpoints · Modelos

API-021 — Listar Itens Dashboard

GET /api/estoque/itens

Finalidade: Listar Itens Dashboard.

Fonte: src/main/java/com/wester/storage/controller/EstoqueController.java:51 — EstoqueController.listarItensDashboard.

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

Headers: Authorization: Bearer <TOKEN>. Accept: application/json recomendado.

Parâmetros:

Nome	Local	Tipo	Obrigatório	Padrão
page	query	int	Não	0
size	query	int	Não	10
areaId	query	Long	Não	—
filtro	query	String	Não	—
sort	query	String	Não	—

Corpo: não declarado; não enviar corpo.

Resposta de sucesso: EstoqueItemDashboardPageResponseDTO. Campos em Modelos.

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

{
  "content": [],
  "page": 0,
  "size": 1,
  "totalElements": 1,
  "totalPages": 0
}

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: EstoqueService.listarItensDashboard. Consulte documento interno de regras de negócio para efeitos persistentes e validações compartilhadas.

cURL (Bash):

curl -X GET "${BASE_URL}/api/estoque/itens" -H "Authorization: Bearer ${TOKEN}"

API-022 — Listar Itens Consolidado

GET /api/estoque/itens-consolidado

Finalidade: Listar Itens Consolidado.

Fonte: src/main/java/com/wester/storage/controller/EstoqueController.java:81 — EstoqueController.listarItensConsolidado.

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

Headers: Authorization: Bearer <TOKEN>. Accept: application/json recomendado.

Parâmetros:

Nome	Local	Tipo	Obrigatório	Padrão
page	query	int	Não	0
size	query	int	Não	10
areaId	query	Long	Não	—
filtro	query	String	Não	—
sort	query	String	Não	—

Corpo: não declarado; não enviar corpo.

Resposta de sucesso: EstoqueItemConsolidadoPageResponseDTO. Campos em Modelos.

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

{
  "content": [],
  "page": 0,
  "size": 1,
  "totalElements": 1,
  "totalPages": 0
}

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: EstoqueConsolidadoService.listarItensConsolidado. Consulte documento interno de regras de negócio para efeitos persistentes e validações compartilhadas.

cURL (Bash):

curl -X GET "${BASE_URL}/api/estoque/itens-consolidado" -H "Authorization: Bearer ${TOKEN}"

API-023 — Retorna o mapa completo do estoque por área

GET /api/estoque/posicoes/area/{areaId}

Finalidade: Retorna o mapa completo do estoque por área.

Fonte: src/main/java/com/wester/storage/controller/EstoqueController.java:102 — EstoqueController.buscarMapaPorArea.

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

Headers: Authorization: Bearer <TOKEN>. Accept: application/json recomendado.

Parâmetros:

Nome	Local	Tipo	Obrigatório	Padrão
areaId	path	Long	Sim	—

Corpo: não declarado; não enviar corpo.

Resposta de sucesso: List<EstoquePosicaoDTO>. Campos em Modelos.

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

[]

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: EstoqueService.buscarMapaPorArea. Consulte documento interno de regras de negócio para efeitos persistentes e validações compartilhadas.

cURL (Bash):

curl -X GET "${BASE_URL}/api/estoque/posicoes/area/1" -H "Authorization: Bearer ${TOKEN}"