Estoque › Listar
Lista o saldo de um CD, posição por posição e lote por lote
GET/v1/objects/stock
Só o que tem quantidade. Paginado (limit até 200), na ordem do endereço. units soma as unidades de todo o filtro, não só da página. Sem depot_code, o CD ativo mais antigo.
Ação da chave:
stock.listQuem cria a chave escolhe as ações que ela abre; sem esta, a rota recusa com api_key_action_not_granted.
Parâmetros da consulta
depot_code string
O código do CD. Sem ele, o CD ativo mais antigo.
limit integer ou string
De 1 a 200; 50 por padrão.
location string
O endereço de uma posição, com ou sem separador (03-05-11-01 ou 03051101).
offset integer ou string
product string
O EAN ou o SKU de um item.
status string
Um ou mais estados separados por vírgula: available, missing, unverified, damaged, quarantine.
Devolve
O data do envelope { ok, data, error, error_code, field, trace_id }:
depot_code string OBRIGATÓRIO
limit integer OBRIGATÓRIO
offset integer OBRIGATÓRIO
stock lista de objeto OBRIGATÓRIO
13 campos
description string
ean string, ou nulo
expires_on string, ou nulo
expiry "expired" | "expiring" | null
Vencido, vencendo dentro do alerta da empresa, ou nulo.
location_code string
lot_code string, ou nulo
product_id uuid
qty_available integer
O que está na posição menos o reservado.
qty_held integer
Reservado por pedido.
qty_on_hand integer
sku string, ou nulo
status string
available, missing, unverified, damaged ou quarantine.
updated_at data e hora
total integer OBRIGATÓRIO
Quantas linhas o filtro acha, somadas as páginas.
units integer OBRIGATÓRIO
Quantas unidades o filtro acha, somadas as páginas.
Recusas
HTTP 400 · Pedido mal formado
invalid_limit HTTP 400limit fora da faixa: de 1 a 200.invalid_offset HTTP 400offset inválido: um inteiro de zero para cima.version_unknown HTTP 400A Kernos-Version pedida não existe. Use uma das versões declaradas no cabeçalho, ou não o mande.HTTP 401 · Sem credencial válida
api_key_expired HTTP 401A chave venceu. Gire a chave no painel e use a nova.api_key_wrong_environment HTTP 401A chave é do outro ambiente: ksk_test_ vai em https://stag.kernos.com.br, ksk_live_ em https://api.kernos.com.br.unauthenticated HTTP 401Credencial ausente, inválida ou expirada.HTTP 403 · Sem permissão
agent_token_out_of_scope HTTP 403O token de agente (kat_) só vale na porta MCP. Para a API, use o token de sessão ou uma chave de integração.api_key_action_not_granted HTTP 403A chave não tem esta ação. Edite as ações da chave no painel.api_key_out_of_scope HTTP 403A chave só vale nas rotas do contrato público.depot_out_of_reach HTTP 403Quem chama não alcança o CD deste objeto. Peça alcance ao CD ou use outra credencial.forbidden_role HTTP 403O papel de quem chama nesta empresa não permite esta ação.module_not_subscribed HTTP 403A empresa não assina o módulo desta rota.tenant_mismatch HTTP 403A credencial não pertence à empresa do endereço chamado.tenant_unavailable HTTP 403A empresa está indisponível no momento.HTTP 404 · Não encontrado
depot_not_found HTTP 404Não existe CD com esse depot_code nesta empresa.HTTP 409 · Conflito
depot_inactive HTTP 409O CD está fechado. Reabra o CD antes de mexer no que está dentro dele.no_active_depot HTTP 409A empresa não tem CD ativo; sem depot_code, não há CD a usar.HTTP 422 · Não processável
invalid_status HTTP 422Situação inválida para este filtro ou campo: use um dos valores declarados.HTTP 429 · Muitos pedidos
rate_limited HTTP 429Muitos pedidos por segundo com esta chave. Espere o Retry-After, em segundos, e tente de novo.curlNodePythonPHPJavaC#GoRust
Lista o saldo de um CD, posição por posição e lote por lote
curl -X GET "https://stag.kernos.com.br/v1/objects/stock?limit=20" \
-H "Authorization: Bearer ksk_test_…" \
-H "Kernos-Version: 2026-10-03"Lista o saldo de um CD, posição por posição e lote por lote
import { Kernos } from '@kernosbr/kernos'
const kernos = new Kernos(process.env.KERNOS_API_KEY)
const result = await kernos.stock.list({ limit: 20 })Lista o saldo de um CD, posição por posição e lote por lote
import os
from kernos import Kernos
kernos = Kernos(os.environ["KERNOS_API_KEY"])
result = kernos.stock.list({"limit": 20})Lista o saldo de um CD, posição por posição e lote por lote
<?php
$kernos = new Kernos\Kernos(getenv('KERNOS_API_KEY'));
$result = $kernos->stock->list(['limit' => 20]);Lista o saldo de um CD, posição por posição e lote por lote
Kernos kernos = new Kernos(System.getenv("KERNOS_API_KEY"));
JsonNode result = kernos.stock().list(Map.of("limit", 20));Lista o saldo de um CD, posição por posição e lote por lote
var kernos = new KernosClient(Environment.GetEnvironmentVariable("KERNOS_API_KEY"));
var result = await kernos.Stock.ListAsync(new Dictionary<string, object?> { ["limit"] = 20 });Lista o saldo de um CD, posição por posição e lote por lote
client, err := kernos.New(os.Getenv("KERNOS_API_KEY"))
result, err := client.Stock.List(ctx, map[string]any{"limit": 20})Lista o saldo de um CD, posição por posição e lote por lote
let kernos = Kernos::new(&std::env::var("KERNOS_API_KEY")?)?;
let result = kernos.stock().list(Some(&json!({ "limit": 20 })), None)?;Resposta · 200 (a forma, sem dado real)
{
"ok": true,
"data": {
"depot_code": "…",
"limit": 0,
"offset": 0,
"stock": [
{
"description": "…",
"ean": "…",
"expires_on": "…",
"expiry": "expired",
"location_code": "…",
"lot_code": "…",
"product_id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
"qty_available": 0,
"qty_held": 0,
"qty_on_hand": 0,
"sku": "…",
"status": "…",
"updated_at": "2026-10-03T12:00:00Z"
}
],
"total": 0,
"units": 0
},
"error": null,
"error_code": null,
"field": null,
"trace_id": null
}Ambiente
ksk_test_ fala com https://stag.kernos.com.br; ksk_live_, com https://api.kernos.com.br. O prefixo da chave escolhe o endereço.