Estoque · Referência

Movimentações de Estoque

Entradas, saídas e ajustes de estoque (com referência à OS quando houver).

Permissão: estoque_movimentacoesAções: ler · criar · exportarglobal (sem carteira)

GET/v1/estoque_movimentacoesListar GET/v1/estoque_movimentacoes/{id}Detalhar GET/v1/estoque_movimentacoes/{id}/pecaRelação: Cadastro de Peças GET/v1/estoque_movimentacoes/exportarExportar em lote POST/v1/estoque_movimentacoesRegistrar entrada/saída

O objeto movimentações de estoque

Campo	Tipo	Descrição
`id`	inteiro	Identificador	ordenar
`part_id`	inteiro	part id	filtro
`stock_item_id`	inteiro	stock item id
`movement_type`	texto (enum)	movement type `entrada` `saida` `ajuste`	filtro
`qty`	decimal (string)	Quantidade
`unit_cost`	decimal (string)	unit cost
`ref_type`	texto	ref type	filtro
`ref_id`	inteiro	ref id	filtro
`notes`	texto	Observações
`created_at`	data-hora	Criado em	ordenar
`created_by_user_id`	inteiro	ID do usuário que criou

Exemplo do objeto200 OK

{
    "id": 1024,
    "part_id": 512,
    "stock_item_id": 512,
    "movement_type": "entrada",
    "qty": "150.00",
    "unit_cost": "150.00",
    "ref_type": "texto",
    "ref_id": 512,
    "notes": "Cliente pediu boleto",
    "created_at": "2026-10-08T14:30:00-03:00",
    "created_by_user_id": 512
}

GET Listar

Retorna os registros paginados, do mais recente para o mais antigo (padrão). Requer Ler.

Parâmetros de consulta

Parâmetro	Tipo	Descrição
`pagina`	inteiro	Página (padrão 1)
`por_pagina`	inteiro	1 a 200 (padrão 50)
`ordenar`	texto	Aceita: `id`, `created_at` — prefixo `-` para decrescente
`campos`	texto	Lista de campos do objeto, separados por vírgula
`part_id`	inteiro	part id — valor exato ou lista separada por vírgula
`movement_type`	texto (enum)	movement type — valor exato ou lista separada por vírgula `entrada` `saida` `ajuste`
`ref_type`	texto	ref type — valor exato ou lista separada por vírgula
`ref_id`	inteiro	ref id — valor exato ou lista separada por vírgula
`criado_desde` / `criado_ate`	data	Período de criação
`atualizado_desde`	data-hora	Criados ou alterados desde (pelo registro de alterações do Mapogos)
`incluir`	texto	Só no detalhe. Relações: `peca`

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes?por_pagina=20" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes?por_pagina=20');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes?por_pagina=20', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes?por_pagina=20",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": [
        {
            "id": 1024,
            "part_id": 512,
            "stock_item_id": 512,
            "movement_type": "entrada",
            "qty": "150.00",
            "unit_cost": "150.00",
            "ref_type": "texto",
            "ref_id": 512
        }
    ],
    "meta": {
        "total": 1,
        "pagina": 1,
        "por_pagina": 20,
        "paginas": 1
    },
    "request_id": "req_0f1e2d3c4b5a69788796"
}

GET Detalhar

Retorna um registro pelo id. Requer Ler.

Use incluir para embutir relações (cada uma exige Ler no módulo relacionado).

Erro	Quando
`404 nao_encontrado`	Não existe ou está fora das carteiras da chave
`403 permissao_negada`	Sem Ler no módulo (ou numa relação pedida)

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes/1024?incluir=peca" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes/1024?incluir=peca');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes/1024?incluir=peca', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes/1024?incluir=peca",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "part_id": 512,
        "stock_item_id": 512,
        "movement_type": "entrada",
        "qty": "150.00",
        "unit_cost": "150.00",
        "ref_type": "texto",
        "ref_id": 512
    },
    "request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}

Relações

Nome	Módulo	Retorno	Rota
`peca`	Cadastro de Peças	um registro	`/v1/estoque_movimentacoes/{id}/peca`

GET Exportar em lote

Até 1000 registros por chamada, paginando por cursor. Requer Ler e Exportar. Aceita os mesmos filtros da listagem e formato=csv. Detalhes no guia Exportação em lote.

Requisição

Testar ▸

curl -X GET "https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes/exportar?limite=1000" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes/exportar?limite=1000');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
  ],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes/exportar?limite=1000', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
  },
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "GET",
    "https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes/exportar?limite=1000",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

POST Registrar entrada/saída

Registrar entrada/saída (atualiza o saldo como no painel). Requer criar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`part_id`	inteiro	obrigatório
`movement_type`	enum	obrigatório	`entrada` `saida`
`qty`	inteiro	obrigatório
`unit_cost`	decimal	opcional	Na entrada, vira o preço unitário da peça (como no painel)
`notes`	texto	opcional	(até 255 caracteres)

Erros possíveis: 422 validacao (lista todos os campos), 409 conflito (estado não permite), 403, 404, 415.

Requisição

Testar ▸

curl -X POST "https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"part_id":12,"movement_type":"entrada","qty":10,"unit_cost":"32.50","notes":"NF 1234"}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER     => [
    'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
    'Content-Type: application/json',
    'Idempotency-Key: ' . bin2hex(random_bytes(16)),
  ],
  CURLOPT_POSTFIELDS     => json_encode([
    'part_id' => 12,
    'movement_type' => 'entrada',
    'qty' => 10,
    'unit_cost' => '32.50',
    'notes' => 'NF 1234',
  ]),
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

if ($resposta['sucesso']) {
  print_r($resposta['dados']);
} else {
  echo $resposta['erro']['mensagem'];
}

const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "part_id": 12,
      "movement_type": "entrada",
      "qty": 10,
      "unit_cost": "32.50",
      "notes": "NF 1234"
  }),
});
const json = await resposta.json();

if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);

import os, uuid, requests

resposta = requests.request(
    "POST",
    "https://apimapogos.sixinformatica.com/v1/estoque_movimentacoes",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "part_id": 12,
        "movement_type": "entrada",
        "qty": 10,
        "unit_cost": "32.50",
        "notes": "NF 1234"
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta201 Created

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "part_id": 512,
        "stock_item_id": 512,
        "movement_type": "entrada",
        "qty": "150.00",
        "unit_cost": "150.00",
        "ref_type": "texto",
        "ref_id": 512
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}