Adueladocumentação

Armazém e stock

O catálogo, as existências por armazém, e o custo de cada saída.

É a base de quase tudo o resto: quem vende, quem compra e quem cozinha mexe no stock deste módulo. Não precisa de licença própria, porque um produto sem catálogo não é um produto. O custo é médio ponderado, recalculado a cada entrada, e é dele que sai a valorização do inventário e a margem de cada venda.

O que a licença destranca

Este módulo não exige licença própria. Está em todos os planos, porque o produto não funciona sem ele.

O que se consegue ver a acontecer

  • Um produto pode controlar lote e validade, e aí a saída escolhe o lote mais antigo
  • Uma transferência entre armazéns sai de um e entra no outro no mesmo instante
  • Um ajuste de existências exige um motivo, e fica no histórico com quem o fez
  • Uma contagem física fecha com as diferenças lançadas de uma vez
  • A valorização do inventário calcula-se a qualquer data passada
  • O catálogo importa-se de uma folha, e recusa-se inteiro se uma linha estiver errada

Os 57 endpoints

Saem da árvore de rotas montada, que é a mesma que serve os pedidos. A referência completa, com corpos e respostas, está em /api.

Método Caminho O que faz
POST /api/v1/armazem/ajustes Corrige o stock à mão
GET /api/v1/armazem/armazens Lista os armazéns
POST /api/v1/armazem/armazens Cria um armazém
DELETE /api/v1/armazem/armazens/:id Inativa um armazém
GET /api/v1/armazem/armazens/:id Mostra um armazém
PUT /api/v1/armazem/armazens/:id Atualiza um armazém
GET /api/v1/armazem/armazens/:id/localizacoes Lista as localizações de um armazém
POST /api/v1/armazem/armazens/:id/localizacoes Cria uma localização
GET /api/v1/armazem/categorias Lista as categorias
POST /api/v1/armazem/categorias Cria uma categoria
DELETE /api/v1/armazem/categorias/:id Apaga uma categoria
PUT /api/v1/armazem/categorias/:id Atualiza uma categoria
GET /api/v1/armazem/contagens Lista as contagens
POST /api/v1/armazem/contagens Abre uma contagem e congela os saldos
GET /api/v1/armazem/contagens/:id Mostra uma contagem com os itens
POST /api/v1/armazem/contagens/:id/cancelar Cancela a contagem sem mexer no stock
GET /api/v1/armazem/contagens/:id/divergencias Só as linhas que não batem certo
POST /api/v1/armazem/contagens/:id/fechar Fecha a contagem e gera os ajustes
POST /api/v1/armazem/contagens/:id/itens Regista o que se contou
GET /api/v1/armazem/disponibilidade Quanto se pode vender agora
GET /api/v1/armazem/fechos Lista os fechos de inventário
POST /api/v1/armazem/fechos Assina um retrato do inventário a uma data
POST /api/v1/armazem/guias Manda mercadoria a caminho de outro armazém
GET /api/v1/armazem/guias/:id Mostra uma guia com as linhas
POST /api/v1/armazem/guias/:id/receber Dá entrada da mercadoria no destino
GET /api/v1/armazem/guias/em-transito O que ainda não chegou
GET /api/v1/armazem/kits/:produto Mostra um kit com os componentes
PUT /api/v1/armazem/kits/:produto Define os componentes de um kit
GET /api/v1/armazem/kits/:produto/disponivel Quantos kits se conseguem montar
DELETE /api/v1/armazem/localizacoes/:id Apaga uma localização
GET /api/v1/armazem/lotes Lotes de um produto, com validade e quantidade
GET /api/v1/armazem/movimentos Movimentos de stock de um produto
GET /api/v1/armazem/produtos Lista o catálogo
POST /api/v1/armazem/produtos Cria um produto
DELETE /api/v1/armazem/produtos/:id Inativa um produto
GET /api/v1/armazem/produtos/:id Mostra um produto
PUT /api/v1/armazem/produtos/:id Atualiza um produto
GET /api/v1/armazem/produtos/:id/variantes Lista as variantes de um produto
POST /api/v1/armazem/produtos/:id/variantes Cria uma variante
GET /api/v1/armazem/produtos/busca Procura por nome, SKU ou código de barras
POST /api/v1/armazem/produtos/importar Importa produtos de um CSV ou XLSX
GET /api/v1/armazem/produtos/importar/modelo Descarrega o modelo de importação
GET /api/v1/armazem/relatorios/curva-abc Onde está o dinheiro, por valor de saída
GET /api/v1/armazem/relatorios/movimentos O extrato do armazém
GET /api/v1/armazem/relatorios/produtos-parados Dinheiro imobilizado há mais de N dias
GET /api/v1/armazem/relatorios/stock-atual O que há em cada armazém, e quanto vale
GET /api/v1/armazem/relatorios/validades Lotes a expirar dentro de N dias
POST /api/v1/armazem/reservas Segura mercadoria que está vendida e ainda não saiu
DELETE /api/v1/armazem/reservas/:id Liberta uma reserva sem que nada saia
POST /api/v1/armazem/reservas/:id/consumir Marca a reserva como cumprida
GET /api/v1/armazem/stock Existência de um produto
POST /api/v1/armazem/transferencias Transfere entre armazéns
GET /api/v1/armazem/unidades Lista as unidades de medida
POST /api/v1/armazem/unidades Cria uma unidade de medida
GET /api/v1/armazem/unidades/conversoes Lista as conversões entre unidades
POST /api/v1/armazem/unidades/conversoes Cria uma conversão
GET /api/v1/armazem/valorizacao Quanto vale o inventário, hoje ou a uma data

Esta página é gerada a partir do código do módulo, com make docs-modulos. O que aqui está muda no mesmo commit em que o módulo muda.