Detalhar pedido

Um pedido completo — itens, resultado, despesas, rastreios e anexos.

GET/v1/pedidos/{id}

Parâmetros

Parâmetro	Tipo	Padrão	Descrição
`id` obrigatório	texto	—	O identificador do pedido (não o número), no caminho.

Exemplo

curl "https://api.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007" \
  -H "Authorization: Bearer otl_prod_SEU_TOKEN"

curl "https://api-sandbox.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007" \
  -H "Authorization: Bearer otl_sbx_SEU_TOKEN"

const resposta = await fetch('https://api.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007', {
  headers: {
    Authorization: 'Bearer otl_prod_SEU_TOKEN',
  },
});

if (!resposta.ok) {
  const { erro } = await resposta.json();
  throw new Error(`${erro.codigo}: ${erro.mensagem} (${erro.requestId})`);
}
const dados = await resposta.json();

const resposta = await fetch('https://api-sandbox.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007', {
  headers: {
    Authorization: 'Bearer otl_sbx_SEU_TOKEN',
  },
});

if (!resposta.ok) {
  const { erro } = await resposta.json();
  throw new Error(`${erro.codigo}: ${erro.mensagem} (${erro.requestId})`);
}
const dados = await resposta.json();

<?php
$ch = curl_init('https://api.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer otl_prod_SEU_TOKEN',
]);

$corpo = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new Exception($corpo['erro']['codigo'] . ': ' . $corpo['erro']['mensagem']);
}

<?php
$ch = curl_init('https://api-sandbox.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer otl_sbx_SEU_TOKEN',
]);

$corpo = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new Exception($corpo['erro']['codigo'] . ': ' . $corpo['erro']['mensagem']);
}

import requests

resposta = requests.get(
    "https://api.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007",
    headers={
        "Authorization": "Bearer otl_prod_SEU_TOKEN",
    },
    timeout=30,
)

if not resposta.ok:
    erro = resposta.json()["erro"]
    raise RuntimeError(f'{erro["codigo"]}: {erro["mensagem"]} ({erro["requestId"]})')
dados = resposta.json()

import requests

resposta = requests.get(
    "https://api-sandbox.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007",
    headers={
        "Authorization": "Bearer otl_sbx_SEU_TOKEN",
    },
    timeout=30,
)

if not resposta.ok:
    erro = resposta.json()["erro"]
    raise RuntimeError(f'{erro["codigo"]}: {erro["mensagem"]} ({erro["requestId"]})')
dados = resposta.json()

Testar agora no ambiente de testes

A chamada é feita de verdade, do seu navegador para a API de testes (https://api-sandbox.otlshoes.com.br/v1). Use um token otl_sbx_…: ele fica só nesta aba, e some ao fechá-la. Token de produção não é aceito aqui.

Token de testeGET

Resposta

{
  "id": "cmg8k1p2a0007",
  "numero": 12,
  "status": "ENVIADO",
  "total": "279.80",
  "origem": "API",
  "referenciaExterna": "PED-778",
  "enviarPara": "CLIENTE",
  "clienteId": "cmg7h2k9x0003",
  "destinatario": {
    "nome": "Maria da Silva",
    "telefone": "5551999990000",
    "endereco": {
      "cep": "90000000",
      "rua": "Rua das Flores",
      "numero": "10",
      "complemento": "ap 2",
      "bairro": "Centro",
      "cidade": "Porto Alegre",
      "uf": "RS"
    }
  },
  "observacao": "Entregar à tarde",
  "itens": [
    {
      "id": "cmg8k1p2a0008",
      "sku": "320",
      "titulo": "Tênis Adidas Forum Low Branco",
      "imagem": "https://cdn.otlshoes.com.br/otl-catalog/320.webp",
      "numeracao": "38",
      "skuVariacao": "320U",
      "quantidade": 2,
      "precoAtacado": "139.90",
      "total": "279.80",
      "valorVenda": "259.90",
      "valorVendaEm": "2026-09-21T09:00:00-03:00"
    }
  ],
  "resultado": {
    "faturamento": "519.80",
    "custo": "279.80",
    "despesas": "10.00",
    "lucroBruto": "240.00",
    "lucro": "230.00",
    "margemPercentual": 44.25,
    "itens": 2,
    "itensSemVenda": 0
  },
  "criadoEm": "2026-09-20T09:15:00-03:00",
  "atualizadoEm": "2026-09-22T14:03:00-03:00",
  "despesas": [
    {
      "id": "cmg8m3d1e0002",
      "descricao": "Embalagem",
      "valor": "10.00",
      "criadoEm": "2026-09-21T09:05:00-03:00"
    }
  ],
  "rastreios": [
    {
      "id": "cmg8n9q4t0001",
      "codigo": "AA123456789BR",
      "transportadora": "Correios",
      "validado": true,
      "cadastradoPeloParceiro": false,
      "criadoEm": "2026-09-22T14:03:00-03:00"
    }
  ],
  "anexos": [
    {
      "id": "cmg8k5z7u0004",
      "tipo": "COMPROVANTE",
      "nomeArquivo": "comprovante-pix.pdf",
      "tipoArquivo": "application/pdf",
      "tamanhoBytes": 51234,
      "validado": true,
      "enviadoPeloParceiro": true,
      "criadoEm": "2026-09-20T09:20:00-03:00"
    }
  ]
}

Os campos do pedido, dos itens e do resultado são os de Listar pedidos. O detalhe acrescenta:

Campo	Tipo	Descrição
`despesas[]`	lista	Custos que o parceiro lançou neste pedido. São dele: a OTL não os usa.
`despesas[].valor`	dinheiro	Sempre positivo.
`rastreios[]`	lista	Códigos de rastreio. Um pedido pode ter mais de um (volumes, troca de transportadora).
`rastreios[].codigo`	texto	Em maiúsculas, sem espaços.
`rastreios[].transportadora`	texto ou null	Como foi informada no cadastro do código.
`rastreios[].validado`	booleano	Conferido pela equipe OTL.
`rastreios[].cadastradoPeloParceiro`	booleano	`true` = cadastrado pelo parceiro; `false` = pela OTL.
`anexos[]`	lista	Arquivos do pedido. Só os dados do arquivo — o conteúdo vem por Baixar anexo.
`anexos[].tipo`	texto	`COMPROVANTE`, `ETIQUETA`, `NOTA_FISCAL`, `DECLARACAO` ou `OUTRO`.
`anexos[].tipoArquivo`	texto	Tipo MIME: PDF, JPEG, PNG ou WebP.
`anexos[].tamanhoBytes`	número	Tamanho do arquivo.
`anexos[].validado`	booleano	Para `COMPROVANTE`: o pagamento foi conferido pela OTL.
`anexos[].enviadoPeloParceiro`	booleano	`false` = enviado pela OTL.

Regras que não se leem no JSON

Use o id, não o numero. O número é por parceiro e serve para falar com pessoas; o id é o que identifica o pedido na API.
Comprovante validado significa pagamento aceito pela OTL — é o sinal mais seguro de que o pedido vai seguir, antes mesmo de o status mudar.

Erros possíveis

HTTP	`codigo`	Quando
404	`NAO_ENCONTRADO`	O pedido não existe — ou é de outro parceiro. A API não diferencia os dois casos
403	`ESCOPO_INSUFICIENTE`	A integração não tem `pedidos:ler`