# Lista o cadastro, com o saldo de cada item

**GET** `/v1/objects/product`

Paginado (`limit` até 200). Filtra por texto, ativo, política, tipo e razão de bloqueio; `depot` recorta o saldo a um CD.

> **Ação da chave: `product.list`** Quem 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

- `active` (string)
- `block_reason` (string)
- `depot` (string): O código do CD que recorta o saldo.
- `limit` (integer ou string): De 1 a 200; 50 por padrão.
- `offset` (integer ou string)
- `order` (string): Vazio é o padrão, `az`.
- `policy` (string)
- `q` (string): Texto na descrição, no SKU ou no EAN.
- `type` (string): O código do tipo de item, ou `none` para os sem tipo.

## Devolve

O `data` do envelope `{ ok, data, error, error_code, field, trace_id }`:

- `limit` (integer, obrigatório)
- `offset` (integer, obrigatório)
- `products` (lista de objeto, obrigatório)
  - `active` (boolean)
  - `assignments` (integer): Em quantas posições o item está.
  - `complete` (boolean): O cadastro tem o que o galpão precisa para operar o item.
  - `created_at` (data e hora)
  - `description` (string)
  - `ean` (string, ou nulo)
  - `id` (uuid)
  - `qty_available` (integer): O que pode ser vendido agora.
  - `qty_blocked` (integer)
  - `qty_expired` (integer): Em lote vencido.
  - `qty_held` (integer): Reservado por pedido.
  - `qty_on_hand` (integer): Tudo o que está no galpão.
  - `qty_on_hold` (integer)
  - `qty_stopped` (integer): Em posição parada.
  - `short_code` (string, ou nulo)
  - `sku` (string, ou nulo)
  - `tracks_lot` (boolean)
  - `traits` (objeto): Os atributos do item, pelo catálogo da empresa, na unidade base (peso em g, medidas em mm).
  - `type_code` (string, ou nulo)
  - `type_id` (string, ou nulo)
  - `type_name` (string, ou nulo)
  - `uom` (string): A unidade de medida, pelo código da NF-e (`H87` é peça).
- `total` (integer, obrigatório): Quantos itens o filtro acha, somadas as páginas.

## Recusas

### HTTP 400 · Pedido mal formado

- [`invalid_active`](/erros/invalid_active.md) (HTTP 400): Filtro de situação inválido: use `true` ou `false`.
- [`invalid_block_reason`](/erros/invalid_block_reason.md) (HTTP 400): Recorte de bloqueio inválido: use `any` ou uma das razões declaradas no parâmetro.
- [`invalid_limit`](/erros/invalid_limit.md) (HTTP 400): `limit` fora da faixa: de 1 a 200.
- [`invalid_offset`](/erros/invalid_offset.md) (HTTP 400): `offset` inválido: um inteiro de zero para cima.
- [`invalid_order`](/erros/invalid_order.md) (HTTP 400): Ordenação inválida: use um dos valores declarados no parâmetro.
- [`invalid_policy`](/erros/invalid_policy.md) (HTTP 400): Recorte de política inválido: use um dos valores declarados no parâmetro.
- [`version_unknown`](/erros/version_unknown.md) (HTTP 400): A `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`](/erros/api_key_expired.md) (HTTP 401): A chave venceu. Gire a chave no painel e use a nova.
- [`api_key_wrong_environment`](/erros/api_key_wrong_environment.md) (HTTP 401): A chave é do outro ambiente: `ksk_test_` vai em https://stag.kernos.com.br, `ksk_live_` em https://api.kernos.com.br.
- [`unauthenticated`](/erros/unauthenticated.md) (HTTP 401): Credencial ausente, inválida ou expirada.

### HTTP 403 · Sem permissão

- [`agent_token_out_of_scope`](/erros/agent_token_out_of_scope.md) (HTTP 403): O 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`](/erros/api_key_action_not_granted.md) (HTTP 403): A chave não tem esta ação. Edite as ações da chave no painel.
- [`api_key_out_of_scope`](/erros/api_key_out_of_scope.md) (HTTP 403): A chave só vale nas rotas do contrato público.
- [`depot_out_of_reach`](/erros/depot_out_of_reach.md) (HTTP 403): Quem chama não alcança o CD deste objeto. Peça alcance ao CD ou use outra credencial.
- [`forbidden_role`](/erros/forbidden_role.md) (HTTP 403): O papel de quem chama nesta empresa não permite esta ação.
- [`module_not_subscribed`](/erros/module_not_subscribed.md) (HTTP 403): A empresa não assina o módulo desta rota.
- [`tenant_mismatch`](/erros/tenant_mismatch.md) (HTTP 403): A credencial não pertence à empresa do endereço chamado.
- [`tenant_unavailable`](/erros/tenant_unavailable.md) (HTTP 403): A empresa está indisponível no momento.

### HTTP 404 · Não encontrado

- [`depot_not_found`](/erros/depot_not_found.md) (HTTP 404): Não existe CD com esse `depot_code` nesta empresa.

### HTTP 422 · Não processável

- [`invalid_value`](/erros/invalid_value.md) (HTTP 422): O texto traz caractere que não se aceita (nulo, U+0000). Tire-o e mande de novo.

### HTTP 429 · Muitos pedidos

- [`rate_limited`](/erros/rate_limited.md) (HTTP 429): Muitos pedidos por segundo com esta chave. Espere o `Retry-After`, em segundos, e tente de novo.

#### curl

**Lista o cadastro, com o saldo de cada item**

```sh
curl -X GET "https://stag.kernos.com.br/v1/objects/product?limit=20" \
  -H "Authorization: Bearer ksk_test_…" \
  -H "Kernos-Version: 2026-10-03"
```

#### Node

**Lista o cadastro, com o saldo de cada item**

```js
import { Kernos } from '@kernosbr/kernos'

const kernos = new Kernos(process.env.KERNOS_API_KEY)
const result = await kernos.product.list({ limit: 20 })
```

#### Python

**Lista o cadastro, com o saldo de cada item**

```python
import os
from kernos import Kernos

kernos = Kernos(os.environ["KERNOS_API_KEY"])
result = kernos.product.list({"limit": 20})
```

#### PHP

**Lista o cadastro, com o saldo de cada item**

```php
<?php
$kernos = new Kernos\Kernos(getenv('KERNOS_API_KEY'));
$result = $kernos->product->list(['limit' => 20]);
```

#### Java

**Lista o cadastro, com o saldo de cada item**

```java
Kernos kernos = new Kernos(System.getenv("KERNOS_API_KEY"));
JsonNode result = kernos.product().list(Map.of("limit", 20));
```

#### C#

**Lista o cadastro, com o saldo de cada item**

```csharp
var kernos = new KernosClient(Environment.GetEnvironmentVariable("KERNOS_API_KEY"));
var result = await kernos.Product.ListAsync(new Dictionary<string, object?> { ["limit"] = 20 });
```

#### Go

**Lista o cadastro, com o saldo de cada item**

```go
client, err := kernos.New(os.Getenv("KERNOS_API_KEY"))
result, err := client.Product.List(ctx, map[string]any{"limit": 20})
```

#### Rust

**Lista o cadastro, com o saldo de cada item**

```rust
let kernos = Kernos::new(&std::env::var("KERNOS_API_KEY")?)?;
let result = kernos.product().list(Some(&json!({ "limit": 20 })), None)?;
```

**Resposta · 200 (a forma, sem dado real)**

```json
{
  "ok": true,
  "data": {
    "limit": 0,
    "offset": 0,
    "products": [
      {
        "active": true,
        "assignments": 0,
        "complete": true,
        "created_at": "2026-10-03T12:00:00Z",
        "description": "…",
        "ean": "…",
        "id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
        "qty_available": 0,
        "qty_blocked": 0,
        "qty_expired": 0,
        "qty_held": 0,
        "qty_on_hand": 0,
        "qty_on_hold": 0,
        "qty_stopped": 0,
        "short_code": "…",
        "sku": "…",
        "tracks_lot": true,
        "traits": {},
        "type_code": "…",
        "type_id": "…",
        "type_name": "…",
        "uom": "…"
      }
    ],
    "total": 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.