Envios › Ler
Lê um envio, com a transportadora, a doca e os volumes com rastreio
GET/v1/objects/shipment/{id}
Cada volume diz o pedido dele, o código curto da etiqueta e o rastreio, quando o canal já mandou.
Ação da chave:
shipment.getQuem cria a chave escolhe as ações que ela abre; sem esta, a rota recusa com api_key_action_not_granted.
Parâmetros do caminho
id string OBRIGATÓRIO
Devolve
O data do envelope { ok, data, error, error_code, field, trace_id }:
shipment objeto OBRIGATÓRIO
9 campos
carrier_cnpj string
carrier_name string
created_at data e hora
depot_id uuid
dispatched_at data e hora, ou nulo
dock_code string
id uuid
packages lista de objeto
7 campos
code string, ou nulo
label_format string, ou nulo
order_ref string
package_id uuid
seq integer
tracking string, ou nulo
weight_g integer, ou nulo
status string
Recusas
HTTP 400 · Pedido mal formado
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
not_found HTTP 404Não existe objeto com esse identificador nesta empresa.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
Lê um envio, com a transportadora, a doca e os volumes com rastreio
curl -X GET "https://stag.kernos.com.br/v1/objects/shipment/<id>" \
-H "Authorization: Bearer ksk_test_…" \
-H "Kernos-Version: 2026-10-03"Lê um envio, com a transportadora, a doca e os volumes com rastreio
import { Kernos } from '@kernosbr/kernos'
const kernos = new Kernos(process.env.KERNOS_API_KEY)
const result = await kernos.shipment.get('<id>')Lê um envio, com a transportadora, a doca e os volumes com rastreio
import os
from kernos import Kernos
kernos = Kernos(os.environ["KERNOS_API_KEY"])
result = kernos.shipment.get("<id>")Lê um envio, com a transportadora, a doca e os volumes com rastreio
<?php
$kernos = new Kernos\Kernos(getenv('KERNOS_API_KEY'));
$result = $kernos->shipment->get('<id>');Lê um envio, com a transportadora, a doca e os volumes com rastreio
Kernos kernos = new Kernos(System.getenv("KERNOS_API_KEY"));
JsonNode result = kernos.shipment().get("<id>");Lê um envio, com a transportadora, a doca e os volumes com rastreio
var kernos = new KernosClient(Environment.GetEnvironmentVariable("KERNOS_API_KEY"));
var result = await kernos.Shipment.GetAsync("<id>");Lê um envio, com a transportadora, a doca e os volumes com rastreio
client, err := kernos.New(os.Getenv("KERNOS_API_KEY"))
result, err := client.Shipment.Get(ctx, "<id>")Lê um envio, com a transportadora, a doca e os volumes com rastreio
let kernos = Kernos::new(&std::env::var("KERNOS_API_KEY")?)?;
let result = kernos.shipment().get("<id>", None)?;Resposta · 200 (a forma, sem dado real)
{
"ok": true,
"data": {
"shipment": {
"carrier_cnpj": "…",
"carrier_name": "…",
"created_at": "2026-10-03T12:00:00Z",
"depot_id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
"dispatched_at": "2026-10-03T12:00:00Z",
"dock_code": "…",
"id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
"packages": [
{
"code": "…",
"label_format": "…",
"order_ref": "…",
"package_id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
"seq": 0,
"tracking": "…",
"weight_g": 0
}
],
"status": "…"
}
},
"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.