Calcular fretes operacionais ou de checkout

Um volume por chamada; não cria envio, etiqueta, reserva ou pagamento. Reutiliza o remetente, os contratos, as permissões e as condições do plano da conta. Operacional retorna preço/prazo antes das regras de checkout; checkout também aplica as regras comerciais do canal integration_api. Orçamento dos provedores: 8 segundos, sem garantia de que o tempo HTTP total se limite a esse valor. 200 com rates=[] e partial=false significa que nenhuma opção final ficou disponível. 200 com partial=true pode ter opções ou rates=[] (por exemplo, as opções obtidas foram ocultadas por regras enquanto outro provedor falhou). 503 quote_unavailable ocorre quando há falha técnica sem candidato utilizável antes das regras. Não há deduplicação por Idempotency-Key: uma resposta perdida pode já ter consumo, e repetir o POST inicia outra cotação. O contador do plano inclui opções finais de contratos próprios e Correios com contrato Veolog; outras transportadoras com contrato Veolog não incrementam esse contador. Opções ocultas/bloqueadas não contam. Os valores operacional e checkout na mesma opção não duplicam o consumo.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[a-z0-9][a-z0-9_-]{0,159}$

Alias exibido nas credenciais existentes da conta.

Body Params
string
enum
required

operational retorna preço/prazo operacional; checkout também aplica as regras de frete da conta.

Allowed:
string
required
^[0-9]{8}$

CEP de origem com 8 dígitos; 00000000 não é aceito.

string
required
^[0-9]{8}$

CEP de destino com 8 dígitos; 00000000 não é aceito.

integer
required
1 to 2000000000
number
required
0 to 10000
number
required
0 to 10000
number
required
0 to 10000
string
enum
required
Allowed:
integer
required
0 to 999999999

Valor em centavos de real; 1990 = R$ 19,90.

string
enum
required
Allowed:
extras
array of strings
length ≤ 20

Adicionais dependem da transportadora e do serviço. Nos Correios: AR = aviso de recebimento (001), MP = mão própria (002), VD = código de valor declarado configurado para o serviço; também são aceitos os códigos diretos habilitados no serviço/contrato. Esses aliases não são universais para outras transportadoras. Omitir preserva os padrões da conta; [] substitui os padrões por lista vazia. Valores repetidos são deduplicados. Um adicional não suportado pode retirar o serviço do resultado. A resposta pública não confirma quais adicionais foram aplicados.

extras
string
^[0-9]{44}$

Opcional na cotação. Exige chave fiscal válida e document_type=nfe.

carriers
array of strings
length between 1 and 20

Filtro opcional por identificadores. Transportadoras documentadas: correios (Correios), jadlog (Jadlog), jtexpress (J&T Express) e loggi (Loggi). Omitir consulta as elegíveis da conta; [] é inválido. Informar um slug não habilita contratos ou transportadoras indisponíveis. Um identificador não elegível pode ser ignorado e resultar em uma lista vazia; não use este campo para descobrir transportadoras.

carriers
checkout
object
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json