API Veltra TMS

Documentação para Integrações

Introdução

Bem-vindo à documentação da API Veltra TMS. Esta API permite que marketplaces e plataformas de e-commerce integrem serviços de logística, incluindo cotação de frete, rastreamento de encomendas e gestão de transportadoras.

Base URL

https://api.veltra.com.br/v1

Formato

Todas as requisições e respostas utilizam JSON.

Autenticação

A API utiliza autenticação via Bearer Token. Inclua o token no header Authorization de todas as requisições.

Nota: O token deve ser obtido através do painel administrativo da Veltra. Entre em contato com nosso suporte para gerar suas credenciais.

ParâmetroTipoObrigatórioDescrição
Authorizationstring
Sim
Bearer {token}
Content-Typestring
Sim
application/json
Cotação de Frete
POST
/api/docs/cotacao

Calcula o valor do frete com base nas dimensões, peso e localidades de origem e destino.

Parâmetros do Request

ParâmetroTipoObrigatórioDescrição
pesonumber
Sim
Peso em kg
alturanumber
Sim
Altura em cm
larguranumber
Sim
Largura em cm
comprimentonumber
Sim
Comprimento em cm
cep_origemstring
Sim
CEP de origem (XXXXX-XXX)
cep_destinostring
Sim
CEP de destino (XXXXX-XXX)
Try it out
Rastreio
GET
/api/docs/rastreio?codigo_rastreamento={codigo}

Retorna o status atual de uma encomenda e todo o histórico de eventos.

Parâmetros de Query

ParâmetroTipoObrigatórioDescrição
codigo_rastreamentostring
Sim
Código de rastreamento único
Try it out
Webhooks

Os webhooks notificam sua aplicação sobre eventos em tempo real. Configure a URL de callback no painel administrativo.

Eventos Disponíveis

frete.cotado

Disparado quando uma cotação é realizada

frete.concluido

Disparado quando a entrega é concluída

frete.exception

Disparado quando ocorre uma exceção na entrega

Assinatura do Webhook

Os webhooks incluem um header X-Veltra-Signaturepara validação. Use o segredo configurado para verificar a autenticidade.