Pular para o conteúdo principal

API SuperFrete

Referência completa da API, gerada a partir da especificação OpenAPI 3.1. Cada endpoint também está disponível em Markdown.

  • Sandbox (testes, etiquetas sem validade) https://sandbox.superfrete.com
  • Produção https://api.superfrete.com

Autenticação

Fluxo OAuth 2.0 para plataformas que conectam várias contas SuperFrete. Quem integra a própria loja usa o token gerado no painel e não precisa deste fluxo.

  • POSTTrocar código OAuth por token/api/v0/oauth/tokenMarkdown

Frete

Cotação de frete e regras de cada serviço (Correios, Jadlog, Loggi e J&T).

  • POSTCotar frete/api/v0/calculatorMarkdown
  • GETConsultar regras dos serviços/api/v0/services/infoMarkdown

Etiquetas

Criação, pagamento e impressão de etiquetas.

  • POSTCriar etiqueta (pedido)/api/v0/cartMarkdown
  • POSTPagar etiqueta com saldo/api/v0/checkoutMarkdown
  • POSTGerar link de impressão/api/v0/tag/printMarkdown

Pedidos

Consulta, listagem e cancelamento dos pedidos (etiquetas) da conta.

  • GETConsultar pedido/api/v0/order/info/{id}Markdown
  • GETListar pedidos/api/v0/me/ordersMarkdown
  • POSTCancelar pedido/api/v0/order/cancelMarkdown

Usuário

Dados da conta autenticada: perfil, saldo, limites e endereços.

  • GETConsultar conta/api/v0/userMarkdown
  • GETListar endereços/api/v0/user/addressesMarkdown

Webhooks

Cadastro dos Webhook Apps que recebem eventos dos pedidos e do rastreio.

  • GETListar Webhook Apps/api/v0/webhookMarkdown
  • POSTCriar Webhook App/api/v0/webhookMarkdown
  • PUTAtualizar Webhook App/api/v0/webhook/{id}Markdown
  • DELETERemover Webhook App/api/v0/webhook/{id}Markdown
  • WEBHOOKEvento de pedidoMarkdown
  • WEBHOOKAtualização de rastreioMarkdown

Prefere ler os guias? Comece pelos primeiros passos.