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.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_tokenstringSimToken identificador da unidade.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
id_token_productstringSimToken do produto a ser movimentado.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
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_token_contactstringNãoToken do contato relacionado à movimentação.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
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": "<access_token>",
"unit_token": "<unit_token>",
"id_token_product": "<id_token_product>",
"type": "<type>",
"quantity": "<quantity>",
"date_in_out": "<date_in_out>",
"id_token_contact": "<id_token_contact>",
"lote": "<lote>",
"validation_date": "<validation_date>",
"unitary_value": "<unitary_value>",
"total_value": "<total_value>"
}'

Resposta​

200 OK​

Movimentação cadastrada com sucesso.

{
"success": true,
"message": "Inventory Moviments inserted successfully",
"data": {
"token": "<token>"
}
}

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).