Documentação da API

POST /get_inventory_moviment

Resumo

Este endpoint permite listar movimentações de estoque de uma unidade específica com opções de filtros.

---

Descrição

Use este endpoint para obter uma lista de movimentações de estoque (entradas e saídas) de uma unidade da plataforma. É possível aplicar filtros por contato, produto, lote, período e tipo de movimentação.

---

Requisição

Body da Requisição

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

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
access_token	string	Sim	Token de autenticação do usuário.	<access_token>
unit_token	string	Sim	Token identificador da unidade.	<unit_token>
id_contact	string	Não	Token do contato para filtrar movimentações.	<id_contact>
id_product	string	Não	Token do produto para filtrar movimentações.	<id_product>
lote	string	Não	Lote para filtrar movimentações (busca parcial).	"LOTE001"
dateRange1	string	Não	Data inicial do período (formato ISO: YYYY-MM-DD).	"2024-01-01"
dateRange2	string	Não	Data final do período (formato ISO: YYYY-MM-DD).	"2024-12-31"
module_type	string	Não	Tipo de movimentação: "in", "out" ou "all" para todas.	"in"

---

Exemplo de Requisição

Curl

curl -X POST 'https://portal.fipli.pro/api/v1/get_inventory_moviment' \
-H 'Content-Type: application/json' \
-d '{
  "access_token": "<access_token>",
  "unit_token": "<unit_token>",
  "id_contact": "<id_contact>",
  "dateRange1": "<dateRange1>",
  "dateRange2": "<dateRange2>",
  "module_type": "<module_type>"
}'

---

Resposta

200 OK

Lista de movimentações obtida com sucesso.

{
  "success": true,
  "data": [
    {
      "token": "<token>",
      "id_unit": "<id_unit>",
      "id_contact": "<id_contact>",
      "active": true,
      "created_date": "<created_date>",
      "type": "<in>",
      "quantity": "<quantity>",
      "id_stock_product": "<id_stock_product>",
      "unit": "<unit>",
      "product": "<product>",
      "lote": "<lote>",
      "validation_date": "<validation_date>",
      "date_in_out": "<date_in_out>",
      "unitary_value": "<unitary_value>",
      "total_value": "total_value",
      "contact_name": "<contact_name>"
    }
  ]
}

Erros Comuns

Status	Mensagem	Descriçã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	"DB Query Error"	Erro interno no servidor.

---

Observações

• Apenas movimentações ativas são retornadas por padrão.
• As datas devem ser fornecidas no formato ISO (YYYY-MM-DD) para os filtros de período.
• Se apenas dateRange1 for fornecida, será filtrado a partir dessa data.
• Se apenas dateRange2 for fornecida, será filtrado até essa data.
• O campo lote faz busca parcial (contém o texto informado).
• Os resultados são ordenados pela data de movimentação em ordem decrescente.
• Valores monetários são retornados sem formatação de moeda.