Árvore de páginas

IMPORTANTE

  • A integração TOTVS OMS x TOTVS Planejamento de Rotas (TPR) será descontinuada no próximo release (Outubro/2023).

Introdução


Sistemas Envolvidos

Integração

  • Formato Excel e 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 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 de Requisição

TPR

Campo

Tipo

Obrigatório

Tamanho

Descrição

Validações

Exemplos

ordersTPROrders[]Sim
Lista de pedidos a serem roteirizados.-Tabela abaixo
localitiesTPRLocality[]Sim
Localidades dos pedido.-Tabela abaixo

TPROrders, tipo de dado utilizado nas integrações do Front-End
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
identifierStringSim4096Identificador do pedido.

Texto livre, deve se único dentro da chamada.

"Entrega Carrefour"

"PED00133"

weightDoubleNão
Peso total os itens do pedido em quilos.

Se preenchido, deve ser maior ou igual a zero;

Validado de acordo com o campo "capacityCriteria";

Se não existirem veículos que suportem este pedido sozinho  na disponibilidade, ele será rejeitado.

25000
volumeDoubleNão
Volume total dos itens do pedido em metros cúbicos.

Se preenchido, deve ser maior ou igual a zero;

Validado de acordo com o campo "capacityCriteria";

Se não existirem veículos que suportem este pedido sozinho  na disponibilidade, ele será rejeitado.

5000
pickupTimeWindowStartDate TimeSim
Início da janela de carregamento.

Formato ISO8601;

PickupStart deve ser anterior a PickupEnd, se ambos forem preenchidos;

PickupStart deve ser anterior ou igual a DeliveryStart , se ambos forem preenchidos;

PickupStart deve ser anterior a DeliveryEnd e ambos devem ser preenchidos.

"2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD"
pickupTimeWindowEndDate TimeNão
Final da janela de carregamento.Formato ISO8601."2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD"
deliveryTimeWindowStartDate TimeNão
Início da janela de entrega.

Formato ISO8601.

"2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD"
deliveryTimeWindowEndDate TimeSim
Final da janela de entrega.

Formato ISO8601;

DeliveryEnd deve vir posterior de DeliveryStart se ambos forem preenchidos;

DeliveryEnd deve vir posterior  ou igual de PickupEnd se ambos forem preenchidos;

DeliveryEnd deve vir posterior de PickupStart e ambos devem ser preenchidos.

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

Tempo de carregamento do pedido em milissegundos.

Se preenchido, deve ser maior que zero, em Milissegundos.

Se não informado, ou menor que 30 minutos serão considerados 30 minutos de serviço;

Se a soma do serviço for maior que 8 horas serão consideradas 8 horas de serviço;

3600000 [ms]
serviceUnloadDurationLongNão

Tempo de descarregamento do pedido em milissegundos.

Se preenchido, deve ser maior que zero, em Milissegundos.

Se não informado, ou menor que 30 minutos serão considerados 30 minutos de serviço;

Se a soma do serviço for maior que 8 horas serão consideradas 8 horas de serviço;

3600000 [ms]
originStringSim
Identificador da localidade de origem do pedido.-Tabela abaixo
destinationStringSim
Identificador da localidade de destino do pedido.-Tabela abaixo

TPRLocality, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
identifierStringSim4096Identificador da localidade.Texto livre, deve se único dentro da chamada."Carrefour Vila Mariana"
operationStringSim
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
addressTRPAddressSim-Endereço da localidade.-Tabela abaixo

TPRAddress, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
identifierStringSim4096Identificador da localidade.Texto livre, deve se único dentro da chamada."Carrefour Vila Mariana"
countryStringSim3Pais do endereço.Formato ISO 3166-1 alfa-3"BRA"
stateStringNão2Estado do endereço.Quando Brasil valida as 27 opções, se informadoSP
cityStringNão4096Cidade do endereço.Texto livreBauru
zipCodeStringNão4096CEP do endereço.Valida formato, se informado e se BRA17047-001
addressStringSim4096Rua, número, Bairro e complemento do endereço.Texto livreGomes de carvalho, 940
latitudeDoubleSim
Latitude do endereço.Intervalo [-90; 90].-23.6114291
longitudeDoubleSim
Longitude do endereço.Intervalo [-180; 180].-46.6946795

Anexos

  Arquivo Modificado
Arquivo PNG TPR_Roteirizacao_FE.png TPR_Roteirizacao_FE exported to image 23 ago, 2021 by Julio Vinicius Oliveira dos Santos
Arquivo TPR_Roteirizacao_FE draw.io diagram 23 ago, 2021 by Julio Vinicius Oliveira dos Santos