Totvs Planejamento de Rotas

Árvore de páginas

Versões comparadas

Versão antiga 18

changes.mady.by.user Danielle Franca de Carvalho

Gravado em

comparado com

Nova versão 19

changes.mady.by.user Usuário desconhecido (willian.godoy)

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Substitui viagem por rota

Introdução

draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
pageId635059308
diagramDisplayName
lboxtrue
diagramNameTPR_Roteirizacao_FE
simpleViewerfalse
width
linksauto
tbstyleinline
diagramWidth480


Sistemas Envolvidos

Integração

  • Formato JSON, para maiores detalhes consulte os Exemplos.

Escopo

  • Integração via front end, compostas pela chamada e pelo retorno, nestas, receberemos uma lista pedidos e, quando possível, retornaremos viagens via rotas via importação e exportação de arquivos;

Pré-requisitos instalação/implantação/utilização

  • Para todos os clientes, contratação do trial via TOTVS Store;

Layout do Callback

TPRRetorno

Campo

Tipo

Obrigatório

Tamanho

Descrição

Validações

Exemplos

tripsResults

TPRTrip[]

Sim


Lista de viagens rotas geradas via otimização


Tabela abaixo

rejections

TPRRejection[]

Não


Lista de rejeites geradas via otimização


Tabela abaixo

message

TPRMessage[]

Não


Campo que deve ser exibido pelo sistema externo para o usuário

-

Tabela abaixo

Âncora
TPRTrip
TPRTrip

TPRTripResults, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
tripIdintegerSim
Índice incremental gerado a cada viagemrota
1, 2 ... 99
distancedoubleSim
Distância total planejada para a viagem rota em km
123 [km]
tollValuedoubleSim
Valor do pedágio total da viagemrotaDepende do campo tollCalculation120,32 [R$]
numberOfStopsintegerSim
Quantidade total de paradas (carregamentos e descarregamentos) da viagemrota

volumedoubleSim
Volume total na viagemrota, em m³
14.32 [m³]
weightdoubleSim
Peso total na viagemrota, em kg
12000 [kg]
durationdoubleSim
Duração total planejada para a viagem rota em milissegundosMaior que zero em milissegundos3600000 [ms]
extraTripBooleanSim
True/Verdadeiro se o veículo disponível, false/falso se não disponível;

considerReturnDistanceBooleanNão

Informa se a distância de retorno a origem na roteirização foi contabilizada.

Tabela para validação de campos Boolean.


vehicleStringSim
Identificador do veículo selecionado para a viagemrota

stopsTPRTripStop[]Sim
Lista de paradas
Tabela abaixo

Âncora
TPRTripStop
TPRTripStop

TPRTripStop, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
stopSequenceintSim
Ordem da parada, iniciando por 1
1, 2 ... 99
stopDistancedoubleSim
 Distância total em km entre uma parada e outraMaior ou igual a zero202 [km]
stopTypeStringSim
Categorização da parada podendo ser: LOAD, UNLOAD, BOTH-
stopTollValuedoubleNão
Valor do pedágio da parada anterior para a atualDepende do campo tollCalculation120,32 [R$]
localityTPRRoutingLocalitySim
Identificador da localidadeTexto Livre"Carrefour vila Mariana"
stopArrivalTimeDateTimeSim
Horário de chegada no formato ISO 8601
2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
stopDepartureTimeDateTimeSim
Horário de saída no formato ISO 8601
2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
loadedOrdersTPRRoutedOrder[]Sim
Lista de pedidos carregados naquela parada
Tabela abaixo
unloadedOrdersTPRRoutedOrder[]Sim
Lista de pedidos descarregados naquela parada
Tabela abaixo

Âncora
TPRRoutingLocality
TPRRoutingLocality

TPRRoutingLocality, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
localityidentifierStringSim4096Identificador da localidadeTexto Livre"Carrefour vila Mariana"
localitycountryStringSim3País do endereçoFomato ISO 3166-1 alfa-3"BRA"
localitylatitudeDoubleSim
LatitudeIntervalo [-90; 90]-23.6114291
localitylongitudeDoubleSim
LongitudeIntervalo [-180; 180]-46.6946795
localityoperationStringSim
Funcionamento simplificado com uma das opções:
UNRESTRICTED, BUSINESS_DAYS, MORNING, AFTERNOON

Opções:

UNRESTRICTED  (00:00-23:59 de Dom-Sab)
BUSINESS_DAYS (08:00-17:59 de Seg-Sex)
MORNING       (08:00-11:59 de Seg-Sex)
AFTERNOON     (14:00-17:59 de Seg-Sex)
BUSINESS_DAYS

Âncora
TPRRoutedOrder
TPRRoutedOrder

TPRRoutedOrder, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
orderServiceTypeStringSim
A categorização da parada podendo ser: LOAD ou UNLOAD
LOAD
orderIdentifierStringSim4096Identificador do pedido
"Entrega Carrefour" "PED00133"
orderWeightDoubleNão
Peso total dos itens do pedido, em kg
25.000
orderVolumeDoubleNão
Volume total dos itens do pedido em m³
5000

Âncora
TPRRejection
TPRRejection

TPRRejection, tipo de dado utilizado nas integrações do TPR (Apenas JSON)
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
messageTPRMessage[]Sim4096


ordersTROrderRejection[]Sim



Âncora
TPROrderRejection
TPROrderRejection

TPROrderRejection, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
IdentifierStringSim4096Identificador do pedido que gerou o rejeite
"Entrega Carrefour" "PED00133"
WeightDoubleNão
 Quantidade rejeitada de peso em kg
25.000
VolumeDoubleNão
Quantidade rejeitada de volume em m³
5000

Âncora
TPRMessage
TPRMessage

TPRMessage: Tipo de dado utilizado nas integrações do TPR (Apenas JSON)

CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
messageCodeStringSim4096Código de identificação da mensagemCódigo existente e validoTPR0001
messageStringSim4096Descrição do motivo do rejeiteTexto Livre"Para finalizar o cadastro acesse seu e-mail e valide o Token"

Anexos
oldfalse