Pular para o conteúdo principal

Documentação da API

POST /insert_inventory_movement

Resumo

Este endpoint permite o cadastro de uma nova movimentação de estoque para uma unidade específica do sistema.


Descrição

Use este endpoint para registrar entradas ou saídas de produtos no estoque de uma unidade da plataforma. É necessário fornecer os tokens de acesso e da unidade, além das informações da movimentação.


Requisição

Body da Requisição

O corpo deve ser um objeto JSON com os seguintes parâmetros:

ParâmetroTipoObrigatórioDescriçãoExemplo
access_tokenstringSimToken de autenticação do usuário.b31643fc-a45f-448c-99ee-736a547f6989
unit_tokenstringSimToken identificador da unidade.e6988e9e-b0c1-410c-ae08-aed7c64ac71f
id_productstringSimToken do produto a ser movimentado.a6927665-6d56-4839-ad23-37d48717da13
typestringSimTipo da movimentação: "in" para entrada ou "out" para saída."in"
quantitystringSimQuantidade movimentada no formato brasileiro (999.999,99)."10,50"
date_in_outstringSimData da movimentação no formato DD/MM/AAAA."15/03/2024"
id_contactstringNãoToken do contato relacionado à movimentação.d125837d-a4f7-4562-91bb-e63db2e86ab2
lotestringNãoIdentificação do lote do produto."LOTE001"
validation_datestringNãoData de validade do produto no formato DD/MM/AAAA."31/12/2024"
unitary_valuestringNãoValor unitário do produto no formato brasileiro (999.999,99)."50,00"
total_valuestringNãoValor total da movimentação no formato brasileiro (999.999,99)."525,00"

Exemplo de Requisição

Curl

curl -X POST 'https://portal.fipli.pro/api/v1/insert_inventory_movement' \
-H 'Content-Type: application/json' \
-d '{
"access_token": "b31643fc-a45f-448c-99ee-736a547f6989",
"unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f",
"id_product": "a6927665-6d56-4839-ad23-37d48717da13",
"type": "in",
"quantity": "10,50",
"date_in_out": "15/03/2024",
"id_contact": "d125837d-a4f7-4562-91bb-e63db2e86ab2",
"lote": "LOTE001",
"validation_date": "31/12/2024",
"unitary_value": "50,00",
"total_value": "525,00"
}'

Resposta

200 OK

Movimentação cadastrada com sucesso.

{
"success": true,
"message": "Inventory Moviments inserted successfully",
"data": {
"token": "c7938887-8f78-6051-cf45-59f6a939fc35"
}
}

Erros Comuns

StatusMensagemDescrição
400"Missing parameters"Algum parâmetro obrigatório não foi enviado na requisição.
403"Invalid data"Token inválido ou não autorizado.
404"Unit not found"A unidade com o token fornecido não foi encontrada no sistema.
500"Parâmetros inválidos"Data de entrada/saída é obrigatória ou em formato inválido.
500"Something went wrong. Please try again later."Erro interno no servidor.

Observações

  • As movimentações ficam atreladas à unidade informada.
  • A data de entrada/saída é obrigatória e deve estar no formato DD/MM/AAAA.
  • Valores monetários devem ser enviados no formato brasileiro com vírgula como separador decimal.
  • Quantidades devem usar vírgula como separador decimal.
  • O campo type aceita apenas "in" (entrada) ou "out" (saída).