Cotar frete

As opções de frete de um pedido, com o preço que sairia da carteira do parceiro.

GET/v1/pedidos/{id}/etiquetas/cotacao

Quando usar

Para escolher o serviço antes de emitir a etiqueta. A cotação não consome saldo e pode ser repetida.

Parâmetros

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

Exemplo

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

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

const resposta = await fetch('https://api.otlshoes.com.br/v1/pedidos/cmg8k1p2a0007/etiquetas/cotacao', {
  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/etiquetas/cotacao', {
  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/etiquetas/cotacao');
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/etiquetas/cotacao');
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/etiquetas/cotacao",
    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/etiquetas/cotacao",
    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

Da mais barata para a mais cara:

{
  "cotacoes": [
    {
      "servico": {
        "id": 17,
        "nome": "Mini Envios"
      },
      "transportadora": "Correios",
      "valor": "14.90",
      "prazoDias": 7
    },
    {
      "servico": {
        "id": 1,
        "nome": "PAC"
      },
      "transportadora": "Correios",
      "valor": "23.72",
      "prazoDias": 5
    },
    {
      "servico": {
        "id": 2,
        "nome": "SEDEX"
      },
      "transportadora": "Correios",
      "valor": "38.10",
      "prazoDias": 2
    }
  ]
}

Campo	Tipo	Descrição
`cotacoes[].servico`	objeto	`id` e `nome`. O `id` é o que vai em `servico` ao emitir.
`cotacoes[].transportadora`	texto	Quem transporta.
`cotacoes[].valor`	dinheiro	O preço para a conta do parceiro.
`cotacoes[].prazoDias`	inteiro	Prazo em dias úteis. `null` quando a transportadora não informa.

Regras que não se leem no JSON

O preço é o da conta do parceiro, cotado com a conta SuperFrete dele: é o que será debitado.
Origem: o endereço da loja na ficha do parceiro; sem ele, o endereço pessoal. Destino: o destinatário do pedido.
O volume é a caixa padrão vezes os pares do pedido. O catálogo não tem peso por produto.
Serviço sem cobertura para o CEP não aparece. A lista pode vir vazia.
O preço pode mudar entre a cotação e a emissão: o valor cobrado é o que volta em valor na etiqueta emitida.

Erros possíveis

HTTP	`codigo`	Quando
400	`SUPERFRETE_NOT_CONNECTED`	O parceiro não tem conta SuperFrete conectada
400	`REQUISICAO_INVALIDA`	A ficha do parceiro não tem endereço de remetente
404	`NAO_ENCONTRADO`	O pedido não existe — ou é de outro parceiro
403	`ESCOPO_INSUFICIENTE`	A integração não tem `etiquetas:ler`