Pular para o conteúdo principal

Enviar viagens

Além do envio de pedidos para montagem de carga via NDD Elog, também é possível enviar viagens por API. Esse endpoint recebe todas as informações necessárias para o transporte como prestador de serviço, veículos, roteirização, documentos, locais de coleta e entrega e componentes do frete, garantindo a integração dos dados e o registro completo da operação.

Montar carga

Ao enviar as viagens, elas podem aparecer no NDD Elog em três etapas diferentes, conforme os campos informados no envio.

1. Roteirização

Se os campos de roteirização não forem enviados, as viagens ficarão com o status Aguardando Roteirização, que corresponde à primeira etapa do processo. Nesse caso, o usuário deverá realizar a roteirização manualmente pela tela do sistema.

O mesmo acontecerá caso apenas alguns campos relacionados à roteirização sejam enviados, já que o sistema precisa de todas as informações obrigatórias para avançar para a próxima etapa. Essa regra também se aplica às etapas seguintes: se faltar qualquer campo necessário, a viagem permanecerá na etapa atual até que os dados sejam preenchidos manualmente ou enviados via integração.

Caso todos os campos exigidos sejam informados no envio, a viagem seguirá diretamente para a etapa de contratação.

Nota

Essa etapa será utilizada apenas se o cliente tiver contratado o módulo Vale-pedágio.

2. Contratação

Nesta etapa aparecerão todas as viagens que não tiveram os campos Prestador e CustosFrete informados. A viagem permanecerá na etapa atual até que os dados sejam preenchidos manualmente ou enviados via integração.

Caso todos os campos exigidos sejam informados no envio, a viagem seguirá diretamente para a etapa de Expedição.

3. Expedição

Esta é a etapa final do processo. Para que a viagem esteja pronta para expedição, é necessário que os campos ChaveNumero, Motorista e Placa sejam enviados previamente ou preenchidos manualmente no sistema.

  • Se todos esses dados forem informados, a viagem será considerada pronta para expedição.
  • Se houver falta da chave de acesso em algum pedido, o status será Dados pendentes.
  • Se estiverem ausentes motorista e/ou placa, o status será Aguardando expedição.

A expedição da viagem deve ser concluída manualmente pelo usuário do sistema, momento em que os documentos associados serão gerados.

Fluxo de envio de viagens via API

Diagrama do fluxo

Exemplo de requisição

  • Método: POST
  • URL: [URL_BASE]/api/v1/Viagem/Planejamento

Cabeçalhos

Content-Type: application/json
Authorization: Bearer {accessToken}

Corpo

Ver detalhes na documentação do endpoint

CampoObrigatórioDescrição
IdentificadorNãoIdentificador único.
TipoVeiculoSimTipo de veículo requerido para a carga (informar objeto com tipo e categoria).
PedidosNãoLista de pedidos que compoem a carga.
TipoOperacaoSimTipo da operação logística (informar objeto com código e descrição).
PrestadorSimDados do prestador de transporte.
CustosFreteNãoDetalhamento dos custos de frete da rota (componentes de frete).
CustosPedidosNãoCustos específicos por pedido, se houver.
MotoristaSimDados do motorista que irá realizar o transporte.
VeiculoTracaoSimDados do veículo de tração utilizado (ex.: caminhão).
VeiculosReboqueNãoLista de veículos de reboque/acoplados que fazem parte da operação.
Roteirizacao
LocalOrigemSimLocal de origem da viagem (endereço completo, dados do ponto de partida).
LocalOrigem.IdentificadorNãoIdentificador do local de origem.
LocalOrigem.DadosSimDados completos do local de origem.
DefinicaoRotaNãoEstratégia de definição da rota: 1 (Eficiente), 2 (Curta), 3 (Evitar pedágio).
CalcularRetornoNãoDefine se o retorno será calculado automaticamente (true / false).
ValorPedagioNãoValor total do pedágio calculado.
DestinosNãoLista de destinos com tipo (coleta/entrega) e ordem sequencial.
Destinos.SequenciaNãoOrdem da parada no trajeto.
Destinos.TipoSimTipo de parada: 1 (Coleta), 2 (Entrega).
DistanciaNãoDistância total estimada da rota (em km).
DuracaoNãoDuração estimada da viagem.
DataCalculoNãoData em que o cálculo da rota foi realizado.
MapaEstaticoBase64NãoImagem da rota em base64.
PolilinhaNãoRepresentação gráfica do trajeto.
PracasPedagio
NomeNãoNome da praça de pedágio.
RodoviaNãoNome da rodovia onde a praça está localizada.
KmNãoQuilômetro em que a praça está posicionada.
ValorNãoValor total cobrado na praça.
ValorPorEixoNãoValor por eixo do veículo, quando aplicável.

Próximos passos

Acompanhe as notificações da viagem.