Estoque · Referência

Cadastro de Peças

Peças cadastradas: código, categoria, preço, estoque mínimo e atual.

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

GET/v1/estoque_pecasListar GET/v1/estoque_pecas/{id}Detalhar GET/v1/estoque_pecas/{id}/movimentacoesRelação: Movimentações de Estoque GET/v1/estoque_pecas/exportarExportar em lote POST/v1/estoque_pecasCadastrar peça PATCH/v1/estoque_pecas/{id}Atualizar peça

O objeto cadastro de peças

Campo	Tipo	Descrição
`id`	inteiro	Identificador	ordenar
`code`	texto	code	filtroordenar
`name`	texto	Nome	ordenar
`description`	texto	Descrição
`category`	texto	category	filtro
`unit`	texto	unit
`min_stock`	decimal (string)	min stock
`current_stock`	decimal (string)	current stock	ordenar
`unit_price`	decimal (string)	Preço unitário
`supplier`	texto	supplier	filtro
`location`	texto	location
`reuse_days`	inteiro	reuse days
`active`	booleano	Ativo (1/0)	filtro
`created_at`	data-hora	Criado em
`updated_at`	data-hora	Atualizado em	ordenar

Exemplo do objeto200 OK

{
    "id": 1024,
    "code": "FO-123",
    "name": "Maria Fernanda Souza",
    "description": "Aluguel semanal",
    "category": "Filtros",
    "unit": "UN",
    "min_stock": "150.00",
    "current_stock": "150.00",
    "unit_price": "150.00",
    "supplier": "Auto Peças Norte",
    "location": "texto",
    "reuse_days": 1,
    "active": false,
    "created_at": "2026-10-08T14:30:00-03:00",
    "updated_at": "2026-10-08T14:30:00-03:00"
}

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`, `name`, `code`, `current_stock`, `updated_at` — prefixo `-` para decrescente
`campos`	texto	Lista de campos do objeto, separados por vírgula
`q`	texto	Busca em: `name`, `code`
`category`	texto	category — valor exato ou lista separada por vírgula
`active`	booleano	Ativo (1/0) — valor exato ou lista separada por vírgula
`code`	texto	code — valor exato ou lista separada por vírgula
`supplier`	texto	supplier — 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 (pela coluna de atualização)
`incluir`	texto	Só no detalhe. Relações: `movimentacoes`

Requisição

Testar ▸

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

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/estoque_pecas?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_pecas?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_pecas?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,
            "code": "FO-123",
            "name": "Maria Fernanda Souza",
            "description": "Aluguel semanal",
            "category": "Filtros",
            "unit": "UN",
            "min_stock": "150.00",
            "current_stock": "150.00"
        }
    ],
    "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_pecas/1024?incluir=movimentacoes" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/estoque_pecas/1024?incluir=movimentacoes');
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_pecas/1024?incluir=movimentacoes', {
  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_pecas/1024?incluir=movimentacoes",
    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,
        "code": "FO-123",
        "name": "Maria Fernanda Souza",
        "description": "Aluguel semanal",
        "category": "Filtros",
        "unit": "UN",
        "min_stock": "150.00",
        "current_stock": "150.00"
    },
    "request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}

Relações

Nome	Módulo	Retorno	Rota
`movimentacoes`	Movimentações de Estoque	lista paginada	`/v1/estoque_pecas/{id}/movimentacoes`

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_pecas/exportar?limite=1000" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY"

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/estoque_pecas/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_pecas/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_pecas/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 Cadastrar peça

Cadastrar peça. Requer criar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`name`	texto	obrigatório	(até 200 caracteres)
`code`	texto	opcional	Único (até 50 caracteres)
`description`	texto	opcional	(até 2000 caracteres)
`category`	texto	opcional	(até 100 caracteres)
`supplier`	texto	opcional	(até 200 caracteres)
`unit_price`	decimal	opcional
`min_stock`	inteiro	opcional
`current_stock`	inteiro	opcional	Saldo inicial/ajuste direto, como no cadastro do painel (prefira movimentações)
`active`	booleano	opcional

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_pecas" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Filtro de óleo","code":"FO-123","unit_price":"35.90","min_stock":5,"category":"Filtros"}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/estoque_pecas');
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([
    'name' => 'Filtro de óleo',
    'code' => 'FO-123',
    'unit_price' => '35.90',
    'min_stock' => 5,
    'category' => 'Filtros',
  ]),
]);
$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_pecas', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "name": "Filtro de óleo",
      "code": "FO-123",
      "unit_price": "35.90",
      "min_stock": 5,
      "category": "Filtros"
  }),
});
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_pecas",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "name": "Filtro de óleo",
        "code": "FO-123",
        "unit_price": "35.90",
        "min_stock": 5,
        "category": "Filtros"
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta201 Created

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "code": "FO-123",
        "name": "Maria Fernanda Souza",
        "description": "Aluguel semanal",
        "category": "Filtros",
        "unit": "UN",
        "min_stock": "150.00",
        "current_stock": "150.00"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}

PATCH Atualizar peça

Atualizar peça. Requer atualizar.

Corpo da requisição (JSON)

Campo	Tipo		Regras
`name`	texto	opcional	(até 200 caracteres)
`code`	texto	opcional	Único (até 50 caracteres)
`description`	texto	opcional	(até 2000 caracteres)
`category`	texto	opcional	(até 100 caracteres)
`supplier`	texto	opcional	(até 200 caracteres)
`unit_price`	decimal	opcional
`min_stock`	inteiro	opcional
`current_stock`	inteiro	opcional	Saldo inicial/ajuste direto, como no cadastro do painel (prefira movimentações)
`active`	booleano	opcional

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

Requisição

Testar ▸

curl -X PATCH "https://apimapogos.sixinformatica.com/v1/estoque_pecas/1024" \
  -H "Authorization: Bearer $MAPOGOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"min_stock":8}'

<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/estoque_pecas/1024');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  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([
    'min_stock' => 8,
  ]),
]);
$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_pecas/1024', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
      "min_stock": 8
  }),
});
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(
    "PATCH",
    "https://apimapogos.sixinformatica.com/v1/estoque_pecas/1024",
    headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}",
             "Idempotency-Key": str(uuid.uuid4())},
    json={
        "min_stock": 8
    },
    timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])

Resposta200 OK

{
    "sucesso": true,
    "dados": {
        "id": 1024,
        "code": "FO-123",
        "name": "Maria Fernanda Souza",
        "description": "Aluguel semanal",
        "category": "Filtros",
        "unit": "UN",
        "min_stock": "150.00",
        "current_stock": "150.00"
    },
    "request_id": "req_6c5b4a3f2e1d0c9b8a7f"
}