Histórico da Página

Introdução

draw.io Diagram

border	true
viewerToolbar	true

fitWindow	false
pageId	635059308
diagramDisplayName
lbox	true
diagramName	TPR_Roteirizacao_FE
simpleViewer	false
width
links	auto
tbstyle	inline
diagramWidth	480

Sistemas Envolvidos

TPR: Front end do TOTVS Planejamento de Rota.

Integração

Formato JSON, para maiores detalhes consulte os Exemplos.

Escopo

Integração via front end, compostas pela chamada e pelo r etorno, 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

Data do envio da resposta no TPR

TPRRetorno
Campo	Tipo	Obrigatório	Tamanho	Descrição	Validações	Exemplos	dateCall	Date Time	Sim	Formato ISO 8601	2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD
version	String	Não	4096	Versão do TPR que executou a resposta	Texto Livre	12.36.1
qualifiers	Object	Não	4096	String chave valor	Formato JSON.	{"Usuário": "Pedro de Alcântara", "Perfil": "Analista"}
summary	TPRSummary	Sim	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

	TPRSummaryTPRTripTPRSummary
	TPRTrip

TPRSummary

TPRTripResults, tipo de dado utilizado nas integrações do TPR

(Apenas JSON)


Campo	Tipo	Obrigatório	Tamanho	Descrição	Validações	Exemplos

totalDistancedoubleSimDistância total do plano de viagens, em kmMaior ou igual a zero3022 [km]totalTrips

tripId

integer

Sim

Quantidade total de viagens do planoMaior ou igual a zero43 [Viagens]totalStopsintegerSimQuantidade total de paradas do plano de viagensMaior ou igual a zero239 [Paradas]totalVolumedoubleSimVolume total em viagens, em m³Maior ou igual a zero50.000 [m³]totalWeightdoubleSimPeso total em viagens, em kgMaior ou igual a zero2.500.000 [kg]totalDurationdoubleSimDuração total do plano de viagens, em milissegundosMaior ou igual a zero57600000 [ms]rejectedOrdersintegerSimQuantidade de pedidos rejeitadosMaior ou igual a zero10 [Pedidos]rejectedWeightdoubleSimTotal de peso rejeitado, em kgMaior ou igual a zero2.500.000 [kg]rejectedVolumedoubleSimTotal de volume rejeitado, em m³Maior ou igual a zero50.000 [m³]

ÂncoraTPRTrip

Índice incremental gerado a cada rota

1, 2 ... 99

TPRTrip

TPRTripResults, tipo de dado utilizado nas integrações do TPR
Campo	Tipo	Obrigatório	Tamanho	Descrição	Validações	Exemplos
distance	double	Sim		Distância total planejada para a viagem rota em km		123 [km]
tollValue	double	Sim		Valor do pedágio total da rota	Depende do campo tollCalculation	120,32 [R$]
numberOfStops	integer	Sim		Quantidade total de paradas (carregamentos e descarregamentos) da viagemrota
volume	double	Sim		Volume total na viagemrota, em m³		14.32 [m³]
weight	double	Sim		Peso total na viagemrota, em kg		12000 [kg]
duration	double	Sim		Duração total planejada para a viagem rota em milissegundos	Maior que zero em milissegundos	3600000 [ms]
extraTrip	Boolean	Sim		True/Verdadeiro se o veiculo veículo disponível, false/falso se não disponível;
considerReturnDistance	Boolean	Não		Informa se a distancia distância de retorno a origem na roteirização foi contabilizada.	Tabela para validação de campos Boolean.
vehicle	StringTPRVehicle	Sim		Identificador do veículo selecionado para a viagemVeículo selecionado da rota
stops	TPRTripStop[]	Sim		Lista de paradas		Tabela abaixo

Âncora

	TPRVehicle
	TPRVehicle

TPRVehicle, tipo de dado utilizado nas integrações do TPR
Campo	Tipo	Obrigatório	Tamanho	Descrição	Validações	Exemplos
identifier	String	Sim	4096	Identificador do tipo do veículo; Quando a disponibilidade for insuficiente, podemos retornar novas instâncias deste veículo marcados como rota extra; Sempre será escolhido para as rotas extras os veículos que minimizem o número de rotas.	Texto livre, deve se único dentro da chamada.	"Truck" "Carreta"
weightCapacity	Double	Sim		Capacidade do veículo em quilos.	Se preenchido, deve ser maior ou igual a zero. Validado de acordo com o campo "capacityCriteria".	25000
volumeCapacity	Double	Sim		Capacidade do veículo em metros cúbicos.	Se preenchido, deve ser maior ou igual a zero. Validado de acordo com o campo "capacityCriteria".	5000
quantity	Integer	Não		Quantidade de veículos, semelhantes a este, disponíveis.	Zerado, nulo ou omitido para os cenários de "Frota Ideal". Se passados valores quebrados apenas a parte inteira será considerada.
speed	Double	Não		Define a velocidade que dos veículos em uma roteirização.	Se preenchido, deve ser maior que zero. Senão, utilizaremos 30 km/h.
vehicleType	String	Não		Tipo de veículo utilizado: TRUCK \| CAR \| MOTORCYCLE	Se não preenchido será considerado TRUCK. É utilizado no calculo do pedágio e para restrições de trafego de caminhões.
tollAxes	Integer	Não		Quantidade de eixos durante a rota.	Se informado será considerado no calculo do pedágio.	6
tollReturnAxes	Integer	Não		Quantidade de eixos durante o retorno para a origem.	Se informado será considerado no calculo do pedágio.	4

Âncora

	TPRTripStop
	TPRTripStop

TPRTripStop, tipo de dado utilizado nas integrações do TPR
Campo	Tipo	Obrigatório	Tamanho	Descrição	Validações	Exemplos
stopSequence	int	Sim		Ordem da parada, iniciando por 1		1, 2 ... 99
stopDistance	double	Sim		Distância total em km entre uma parada e outra	Maior ou igual a zero	202 [km]
stopType	String	Sim		Categorização da parada podendo ser: LOAD, UNLOAD, BOTH	-
stopTollValue	double	Não		Valor do pedágio da parada anterior para a atual	Depende do campo tollCalculation	120,32 [R$]
locality	TPRRoutingLocality	Sim		Identificador da localidade	Texto Livre	"Carrefour vila Mariana"

arrivalTime

stopArrivalTime

DateTime

Sim

Horário de chegada no formato ISO 8601

2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD

departureTime

stopDepartureTime	DateTime	Sim	Horário de saída no formato ISO 8601	2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD
loadedOrders	TPRRoutedOrder[]	Sim	Lista de pedidos carregados naquela parada	Tabela abaixo
unloadedOrders	TPRRoutedOrder[]	Sim	Lista de pedidos descarregados naquela parada	Tabela abaixo

Âncora

	TPRRoutingLocality
	TPRRoutingLocality

TPRRoutingLocality, tipo de dado utilizado nas integrações do TPR
Campo	Tipo	Obrigatório	Tamanho	Descrição	Validações	Exemplos
localityidentifier	String	Sim	4096	Identificador da localidade	Texto Livre	"Carrefour vila Mariana"
localitycountry	String	Sim	3	País do endereço	Fomato ISO 3166-1 alfa-3	"BRA"
localitylatitude	Double	Sim		Latitude	Intervalo [-90; 90]	-23.6114291
localitylongitude	Double	Sim		Longitude	Intervalo [-180; 180]	-46.6946795
localityoperation	String	Sim		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
Campo	Tipo	Obrigatório	Tamanho	Descrição	Validações	Exemplos
orderServiceType	String	Sim		A categorização da parada podendo ser: LOAD ou UNLOAD		LOAD
orderIdentifier	String	Sim	4096	Identificador do pedido		"Entrega Carrefour" "PED00133"
orderWeight	Double	Não		Peso total dos itens do pedido, em kg		25.000
orderVolume	Double	Nã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)
Campo	Tipo	Obrigatório	Tamanho	Descrição	Validações	Exemplos
message	TPRMessage[]	Sim	4096
orders

TRPRoutedOrder

TROrderRejection[]

Sim

Âncora

	TPRRoutedOrderTPROrderRejectionTPRRoutedOrder
	TPROrderRejection

TPRRoutedOrder

TPROrderRejection, tipo de dado utilizado nas integrações do

TPR (Apenas JSON)

TPR
Campo	Tipo	Obrigatório	Tamanho	Descrição	Validações	Exemplos

identifierTexto livre

Identifier

String

Sim

4096

Identificador do pedido

que gerou o rejeite

"Entrega Carrefour" "PED00133"

weight

Weight

Double

Não

Peso total os itens do pedido, em kgSe não tiver peso tem que ter volume;
Todos os pedidos da roteirização devem ter o mesmo limitador (Peso ou Volume);

Quantidade rejeitada de peso em kg

25.000

volume

Volume

Double

Não

Volume total dos itens do pedido em m³Se não tiver volume tem que ter peso;
Todos os pedidos da roteirização devem ter o mesmo limitador (Peso ou Volume);

Quantidade rejeitada de volume em m³

5000

Âncora
TPRMessage
TPRMessage

TPRMessage: Tipo de dado utilizado nas integrações do TPR (Apenas JSON)
Campo	Tipo	Obrigatório	Tamanho	Descrição	Validações	Exemplos
messageCode	String	Sim	4096	Código de identificação da mensagem	Código existente e valido	TPR0001
message	String	Sim	4096	Mensagem escritaDescrição do motivo do rejeite	Texto Livre	"Para finalizar o cadastro acesse seu e-mail e valide o Token"

Anexos

old	false

Árvore de páginas

Versões comparadas

Versão antiga 11

Nova versão Atual

Chave

Sistemas Envolvidos

Integração

Escopo

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

Layout do Callback

Âncora
TPRMessage
TPRMessage

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 11

Nova versão Atual

Chave

Sistemas Envolvidos

Integração

Escopo

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

Layout do Callback

ÂncoraTPRMessage TPRMessage

Âncora
TPRMessage
TPRMessage