Pular para o conteúdo
Entrar Começar
API e webhooksv1
openapi.yaml
Menu da APIEstoque · Listar saldos de peças prontas

Listar saldos de peças prontas

GET https://api.precificador3d.com.br/v1/estoque

Escopo: estoque:ler. Mostra o local próprio e, só para leitura, as lojas do consignado.

cURL

curl "https://api.precificador3d.com.br/v1/estoque?limite=25" \
  -H "Authorization: Bearer $PC3D_CHAVE"

JavaScript

const resposta = await fetch('https://api.precificador3d.com.br/v1/estoque?limite=25', {
  headers: {
    Authorization: `Bearer ${process.env.PC3D_CHAVE}`,
  },
});
if (!resposta.ok) {
  const erro = await resposta.json(); // application/problem+json
  throw new Error(`${erro.codigo}: ${erro.detail} (${erro.requisicao_id})`);
}
const dados = await resposta.json();

Python

import os

import requests

resposta = requests.get(
    "https://api.precificador3d.com.br/v1/estoque",
    params={
        "limite": 25,
    },
    headers={
        "Authorization": f"Bearer {os.environ['PC3D_CHAVE']}",
    },
    timeout=10,
)
resposta.raise_for_status()
dados = resposta.json()

Parâmetros de consulta

limiteinteger
Itens por página, de 1 a 100. Acima de 25 conta como operação cara. (de 1 a 100; padrão 25)
cursorstring
Valor de proximo_cursor da página anterior. Opaco. (até 200 caracteres)
ordemstring
Ordenação. - na frente = decrescente. (padrão "-atualizado_em") Valores: atualizado_em, -atualizado_em, criado_em, -criado_em.
atualizado_desdestring (date-time)
Só o que mudou a partir deste instante. Use com ordem=atualizado_em para reconciliar depois de webhooks.
produto_idstring (uuid)
variacao_idstring (uuid)
local_idstring (uuid)

Cabeçalhos

If-None-Matchstring
ETag recebida antes. Se nada mudou, a resposta é 304 e não gasta a cota mensal. (até 100 caracteres)

Resposta 200

Página de saldos.

Campos da resposta (12)
dadosarray de SaldoEstoque
(0 a 100 itens)
dados[].variacao_idstring (uuid)
dados[].produto_idstring (uuid)
dados[].skustring | null
dados[].localobject
dados[].local.idstring (uuid)
dados[].local.tipostring
Valores: proprio, consignatario.
dados[].local.nomestring
dados[].parte_idstring (uuid) | null
Parte solta guardada; null = peça completa.
dados[].saldointeger
dados[].atualizado_emstring (date-time)
proximo_cursorstring | null
Cursor da próxima página, ou null no fim.
200 Resposta 
{
  "dados": [
    {
      "variacao_id": "6b7c8d9e-0f1a-4b2c-3d4e-5f6a7b8c9d0e",
      "produto_id": "5a6b7c8d-9e0f-4a1b-2c3d-4e5f6a7b8c9d",
      "sku": "CHAV-DRG-AZ",
      "local": {
        "id": "7c8d9e0f-1a2b-4c3d-4e5f-6a7b8c9d0e1f",
        "tipo": "proprio",
        "nome": "Estoque próprio"
      },
      "parte_id": null,
      "saldo": 42,
      "atualizado_em": "2026-10-03T08:30:00-03:00"
    }
  ],
  "proximo_cursor": null
}

Outras respostas

  • 304 Nada mudou desde a ETag informada.
  • 400 dados_invalidos: Dados, filtro, cursor ou cabeçalho inválido.
  • 401 nao_autenticado: Chave ausente, malformada, desconhecida, revogada ou expirada (a resposta é a mesma para todos os casos).
  • 403 escopo_insuficiente: Escopo insuficiente, conta bloqueada, módulo desligado ou chave suspensa.
  • 429 limite_excedido: Limite de uso excedido (rajada, minuto, mês ou requisições simultâneas).
  • 500 erro_interno: Erro interno. O detalhe fica no log, ligado ao requisicao_id.
  • 503 indisponivel: API desligada, sob pressão (disjuntor aberto) ou no limite global da plataforma.

Esta página em Markdown · llms.txt