¶ Atualizações API - Estoque
Lembrando que para realizar qualquer requisição é necessário um usuário de api autenticado e a url para realizar a requisição
¶ Locais de Estoque
Referente aos locais de estoque as rotas permaneceram as mesmas sendo possÃvel listar e localizar o local de estoque pelo o id do local.
¶ GET - Listar
Através desse endpoint GET - Listar, irá consultar/listar os dados de locais de estoque e retornar um JSON como resposta. Os dados serão retornados de forma paginada, portanto fique atento ao conjunto da dados «paginacao» que é retornado na resposta, para saber se será necessário consultar outras páginas ou não.
Rota para utilização: /api/v1/integracao/estoque/local_estoque?pagina=0&itens_por_pagina=100
Os parâmetros disponÃveis seriam a pagina e itens_por_pagina, sendo obrigatório como parâmetro a pagina para informar o número da página e o itens_por_pagina seria um parâmetro opcional que caso não seja preenchido será atribuÃdo 100 itens por página.
Exemplo da requisição feita e seu retorno
¶ GET - Encontrar por ID
Através desse endpoint GET - Encontrar por ID, será possÃvel consultar um produto individualmente. Esse endpoint pode ser útil quando for necessário verificar / sincronizar produto por produto.
Rota para utilização: /api/v1/integracao/estoque/local_estoque/:id_local_estoque
Os parâmetros necessarios seriam o id_local_estoque, e ao consultar ele retorna os dados de acordo com esse id que foi consultado.
Exemplo da requisição feita e seu retorno
¶ Movimentações de Estoque
Através da rota de movimentos de estoque foi centralizado as movimentações realizadas através da api, como e feito no sistema.
A rota de movimentações de produtos foi descontinuada e não será mais utilizada no novo modulo de estoque.
¶ GET - Listar
Através desse endpoint GET - Listar, irá consultar/listar as movimentações de estoque e retornar um JSON como resposta. Os dados serão retornados de forma paginada, portanto fique atento ao conjunto da dados «paginacao» que é retornado na resposta, para saber se será necessário consultar outras páginas ou não.
Rota para utilização: /api/v1/integracao/estoque/movimento_estoque?pagina=integer&itens_por_pagina=integer&data_inicio=YYYY-MM-DD &data_fim=YYYY-MM-DD &tipo_data=cadastro,edicao,movimento
Os parâmetros disponÃveis seriam a pagina, itens_por_pagina, data_inicio, data_fim e tipo_data, sendo obrigatorio como parâmetro apenas a pagina para informar o numero da página, itens_por_pagina seria um parâmetro opcional que caso não seja preenchido sera atribuido 100 itens por página, data_inicio e data_fim tambem um parâmetro adicional que seria para puxar de um periodo de datas especifico e tipo_data tambem um parâmetro adicional que determina o tipo de data que será utilizado para filtrar.
Exemplo da requisição feita e seu retorno
¶ GET - Encontrar por ID
Através desse endpoint GET - Encontrar por ID, será possÃvel capturar todos os dados de um movimento de estoque, seja ele de saÃda ou entrada.
Rota para utilização: /api/v1/integracao/estoque/movimento_estoque/:id_movimento_estoque
Os parâmetros necessarios seriam o id_movimento_estoque, e ao consultar ele retorna os dados de acordo com esse id que foi consultado.
Exemplo da requisição feita e seu retorno
¶ POST - Adicionar Produtos
Através desse endpoint POST - Adicionar Produtos, será possÃvel adicionar produtos a um local de estoque sem a necessidade de gerar uma nova compra dentro do sistema.
Rota para utilização: /api/v1/integracao/estoque/movimento_estoque
O body da requisição deve conter o id_local_estoque, quantidade de produtos e o id_produto do produto que deseja adicionar ao local de estoque.
Exemplo da requisição feita e seu retorno
¶ POST - Transferência entre Estoques
Através desse endpoint POST - Transferência entre Estoques, será possÃvel mover produtos de um local de estoque para outro.
Rota para utilização: /api/v1/integracao/estoque/movimento_estoque/transferencia
O body da requisição deve conter o id_local_estoque_origem, id_local_estoque_destino e produtos que seria um objeto que contém os ID’s dos produtos, quantidades e patrimônios a serem transferidos.
Exemplo do objeto do produto
Exemplo do body que deve ser enviado na requisição contendo os locais de estoque e o objeto do produto
Exemplo da requisição feita e seu retorno
¶ DELETE - Apagar Produtos
Através desse endpoint DELETE - Apagar Produtos, será possÃvel apagar movimentações de estoque de entrada adicionadas através do endpoint Adicionar Produtos, também documentado aqui.
Rota para utilização: /api/v1/integracao/estoque/movimento_estoque/:id_movimento_estoque
Os parâmetros necessarios seriam o id_movimento_estoque que foi realizado através de uma entrada utilizando o endpoint Adicionar Produtos, e dessa forma ele sera apagado caso não tenha sido gerada nenhuma movimentação com os produtos dessa entrada.
Exemplo da requisição feita e seu retorno
¶ Produto
Referente aos produtos as rotas permaneceram as mesmas sendo possÃvel listar, encontrar produto por id do produto, adicionar, editar e apagar os produtos cadastrados no sistema, o que foi alterado seria os atributos de alguns endpoints.
¶ GET - Listar
Através desse endpoint GET - Listar, irá consultar/listar os dados de produtos e retornar um JSON como resposta. Os dados serão retornados de forma paginada, portanto fique atento ao conjunto da dados «paginacao» que é retornado na resposta, para saber se será necessário consultar outras páginas ou não.
Rota para utilização: /api/v1/integracao/estoque/produto?pagina=0&itens_por_pagina=100&data_inicio=YYYY-MM-DD&data_fim=YYYY-MM-DD
Os parâmetros que devem ser utilizados são a pagina, itens_por_pagina, data_inicio, data_fim, a pagina para informar o numero da pagina, itens_por_pagina seria um parâmetro opcional que caso não seja preenchido sera atribuido 100 itens por pagina, data_inicio e data_fim tambem um parâmetro adicional que seria para puxar de um periodo de datas de cadastro do produto especifica.
Exemplo da requisição feita e seu retorno
¶ GET - Encontrar por ID
Através desse endpoint GET - Encontrar por ID, será possÃvel consultar um produto individualmente. Esse endpoint pode ser útil quando for necessário verificar / sincronizar produto por produto
Rota para utilização: /api/v1/integracao/estoque/produto/:id_produto
Os parâmetros necessarios seriam o id_produto ja cadastrado anteriomente, e ao consultar ele retorna os dados de acordo com esse id que foi consultado.
Exemplo da requisição feita e seu retorno
¶ POST - Adicionar
Através desse endpoint POST - Adicionar Produtos, será possÃvel adicionar novos produtos ao cadastro.
Rota para utilização: /api/v1/integracao/estoque/produto
O body da requisição deve conter obrigatoriamente nome, unidade_medida, valor_compra, valor_venda, controle_patrimonial, epi, produto_categoria.id_protudo_categoria e produto_marca.id_produto_marca, porem existem outros atributos que podem ser adicionados.
Exemplo dos atributos
Valores que eles aceitam
Exemplo da requisição feita e seu retorno
Observação: O parâmetro agrupado irá indicar se o produto irá gerenciar os itens como patrimônio ou não. Caso o produto seja cadastrado com a opção agrupado = false (que é o padrão), significa que cada unidade do produto, precisará ter um produto_item (patrimônio) no estoque.
Caso o produto seja cadastrado com a opção agrupado = true siginfica que será necessário cadastrar apenas 1 item no local de estoque contendo toda a quantidade de estoque disponÃvel, ou seja, estará tudo agrupado.
¶ PUT - Editar
Através desse endpoint POST - Editar, será possÃvel editar produtos ja cadastrados anteriomente.
Rota para utilização: /api/v1/integracao/estoque/produto/:id_produto
O body da requisição deve conter obrigatoriamente nome, unidade_medida, valor_compra, valor_venda, epi, porem existem outros atributos que podem ser adicionados.
Exemplo dos atributos
Valores que eles aceitam
Exemplo da requisição feita e seu retorno
Observação: O parâmetro agrupado não é permitido alterar na edição via API. Caso seja necessário modificar esse parâmetro, o mesmo deverá ser ajustado via sistema, pois ao editar essa informação, o sistema poderá remover todos os patrimônios já cadastrados, ou seja, é uma função de impacto crÃtico.
¶ DELETE - Apagar
Através desse endpoint DELETE - Apagar Produtos, será possÃvel apagar movimentações de estoque de entrada adicionadas através do endpoint Adicionar Produtos, também documentado aqui.
Rota para utilização: /api/v1/integracao/estoque/produto/:id_produto
Os parâmetros necessarios seriam o id_produto.
Exemplo da requisição feita e seu retorno
¶ Patrimonio
Através da rota de patrimonios é possivel listar os patrimonios, encontrar pelo id do patrimonio e editar as informações de um patrimonio, essa rota entra no lugar da rota que antes se chamava de «Produto Item» e alguns endpoints foram removidos como o de adicionar, movimentar, transferencia entre estoques e apagar.
A rota de «Produto Item» foi descontinuada e não sera mais utilizada no novo modulo de estoque.
¶ GET - Listar
Através desse endpoint GET - Listar, irá consultar/listar os dados de produtos e retornar um JSON como resposta. Os dados serão retornados de forma paginada, portanto fique atento ao conjunto da dados «paginacao» que é retornado na resposta, para saber se será necessário consultar outras páginas ou não.
Rota para utilização: /api/v1/integracao/estoque/produto_item?id_produto=integer&pagina=integer&itens_por_pagina=integer
Os parâmetros que disponiveis são a id_produto, pagina, itens_por_pagina, data_inicio, data_fim, os parâmetros obrigatorios seriam id_produto para que retorne no JSON os patrimonios dessa produto e a pagina para informar o numero da pagina, itens_por_pagina seria um parametro opcional que caso não seja preenchido sera atribuido 100 itens por pagina, data_inicio e data_fim tambem um parâmetro adicional que seria para puxar de um periodo de datas de cadastro do produto especifica.
Exemplo da requisição feita e seu retorno
¶ GET - Encontrar por ID
Através desse endpoint GET - Encontrar por ID, será possÃvel consultar um produto individualmente. Esse endpoint pode ser útil quando for necessário verificar / sincronizar produto por produto.
Rota para utilização: /api/v1/integracao/estoque/produto_item/:id_produto_item
Os parametros necessarios seriam o id_produto_item ja cadastrado anteriormente, e ao consultar ele retorna os dados de acordo com esse id que foi consultado.
Exemplo da requisição feita e seu retorno
¶ PUT - Editar
Através desse endpoint POST - Editar, será possÃvel editar os dados de cadastro do item de produto.
Rota para utilização: /api/v1/integracao/estoque/produto_item/:id_produto_item
O body da requisição deve conter obrigatoriamente id_produto, id_local_estoque, e esta disponivel como atributos opcionais o numero_serie, mac_address, identificador_proprio e observacoes.
Exemplo dos atributos
Valores que eles aceitam
Exemplo do parametro que deve ser utilizado
Exemplo da requisição feita e seu retorno
