KernosDevelopers
Sair
Referência Pedidos de venda › Ler
Pedidos de venda › Ler

Lê um pedido, com as linhas, os volumes e a nota

GET/v1/objects/sales-order/{id}

Cada linha diz quanto já foi separado (picked) e embalado (packed); o kit traz os componentes. invoice é nulo até a nota chegar.

Ação da chave: sales_order.get

Quem 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 }:

sales_order objeto OBRIGATÓRIO
17 campos
carrier_cnpj string, ou nulo
channel string, ou nulo
channel_ref string, ou nulo
created_at data e hora
customer string, ou nulo
customer_area string, ou nulo
depot_id uuid
id uuid
invoice objeto, ou nulo

A nota fiscal, quando já chegou.

6 campos
at data e hora, ou nulo
issued_at data e hora, ou nulo
key string

A chave de 44 dígitos.

number string, ou nulo
series string, ou nulo
source string, ou nulo
lines lista de objeto
9 campos
components lista de objeto

Os itens do kit; vazio no produto comum.

description string
ean string, ou nulo
id uuid
packed integer
picked integer
qty integer
seq integer
sku string
order_ref string
origin string, ou nulo
packages lista de objeto
5 campos
id uuid
seq integer
status string
units integer
weight_g integer, ou nulo
paid_note string, ou nulo
pick_orders lista de objeto

As OS que separaram o pedido (3/10). Vazia antes da onda.

3 campos
id uuid
short_code string, ou nulo
status string
status string
waves lista de objeto

A onda que liberou o pedido (3/10). Vazia antes da onda.

2 campos
code string, ou nulo
id uuid

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 pedido, com as linhas, os volumes e a nota
curl -X GET "https://stag.kernos.com.br/v1/objects/sales-order/<id>" \
  -H "Authorization: Bearer ksk_test_…" \
  -H "Kernos-Version: 2026-10-03"
Resposta · 200 (a forma, sem dado real)
{
  "ok": true,
  "data": {
    "sales_order": {
      "carrier_cnpj": "…",
      "channel": "…",
      "channel_ref": "…",
      "created_at": "2026-10-03T12:00:00Z",
      "customer": "…",
      "customer_area": "…",
      "depot_id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
      "id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
      "invoice": {
        "at": "2026-10-03T12:00:00Z",
        "issued_at": "2026-10-03T12:00:00Z",
        "key": "…",
        "number": "…",
        "series": "…",
        "source": "…"
      },
      "lines": [
        {
          "components": [],
          "description": "…",
          "ean": "…",
          "id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
          "packed": 0,
          "picked": 0,
          "qty": 0,
          "seq": 0,
          "sku": "…"
        }
      ],
      "order_ref": "…",
      "origin": "…",
      "packages": [
        {
          "id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
          "seq": 0,
          "status": "…",
          "units": 0,
          "weight_g": 0
        }
      ],
      "paid_note": "…",
      "pick_orders": [
        {
          "id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
          "short_code": "…",
          "status": "…"
        }
      ],
      "status": "…",
      "waves": [
        {
          "code": "…",
          "id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50"
        }
      ]
    }
  },
  "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.