TPR | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos | dateCall | Date Time | Sim | Data da criação da chamada no sistema externo. | Formato ISO8601. | 2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD | ||||||
system | String | Não | 4096 | Identificador do sistema que fez a chamada. | Texto Livre. | Protheus | ||||||||||||
version | String | Não | 4096 | Versão do sistema externo. | Texto Livre. | 12.36.1 | ||||||||||||
qualifiers | Object | Não | 4096 | String chave valor. | Formato JSON. | {"Usuário": "Pedro de Alcântara", "Perfil": "Analista"} | callbackURL | String | Sim | 4096 | URL de Callback. | Início com "https://". | ||||||
callbackAuthenticationType | String | Sim | 4096 | Tipos de autenticação: BASIC, NONE | Opções: BASIC, NONE. | NONE | ||||||||||||
callbackAuthenticationValue | String | Não | 4096 | Texto de acordo com formato indicado.Texto Livre. | QWxhZGRpbjpvcGVuIHNlc2FtZQ== | |||||||||||||
orders | TPRRoutingOrders[] | Sim | Lista de pedidos a serem roteirizados. | Tabela abaixo | ||||||||||||||
vehicleslocalities | TPRRoutingVehiclesTPRLocality[] | Sim | Lista de veículos disponíveis para a roteirização. | Tabela abaixo | restrictions | TRPRoutingRestrictions | Sim | Restrições de roteirização. | Tabela abaixo | options | TPRRoutingOptions | Sim | Opções de roteirização. | Tabela abaixo | Localidades dos pedido | - | Tabela abaixo |
Âncora | ||||
---|---|---|---|---|
|
TPROrders |
---|
TPRRoutingOrders, tipo de dado utilizado nas integrações do TPRFront-End | ||||||
---|---|---|---|---|---|---|
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
identifier | String | Sim | 4096 | Identificador do pedido | Texto livre, deve se único dentro da chamada. | "Entrega Carrefour" "PED00133" |
weight | Double | Nã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 | |
volume | Double | Nã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 | |
pickupTimeWindowStart | Date Time | Sim | 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" | |
pickupTimeWindowEnd | Date Time | Não | Final da janela de carregamento | Formato ISO8601. | "2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD" | |
deliveryTimeWindowStart | Date Time | Não | Início da janela de entrega | Formato ISO8601. | "2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD" | |
deliveryTimeWindowEnd | Date Time | Sim | 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" | |
serviceLoadDuration | Long | Não | 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; | Se preenchido, deve ser maior que zero, em Milissegundos. | 3600000 [ms] | |
serviceUnloadDuration | Long | Não | 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; | Se preenchido, deve ser maior que zero, em Milissegundos. | 3600000 [ms] | |
origin | TPRRoutingLocalityString | Sim | Localidade Identificador da localidade de origem do pedido. | - | Tabela abaixo | |
destination | TPRRoutingLocalityString | Sim | Localidade Identificador da localidade de destino do pedido | - | Tabela abaixo |
Âncora | ||||
---|---|---|---|---|
|
TPRRoutingLocalityTPRLocality, tipo de dado utilizado nas integrações do TPR | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos | |||||||||||||||||||
identifier | String | Sim | 4096 | Identificador da localidade. | Texto livre, deve se único dentro da chamada. | "Carrefour Vila Mariana" | country | String | Sim | 3 | País do endereço. | Fomato ISO 3166-1 alfa-3. | "BRA" | latitude | Double | Sim | Latitude. | Intervalo [-90; 90]. | -23.6114291 | longitude | Double | Sim | Longitude. | Intervalo [-180; 180]. | -46.6946795 |
operation | String | Sim | Funcionamento simplificado. | Opções: UNRESTRICTED (00:00-23:59 de Dom-Sab) | BUSINESS_DAYS | ||||||||||||||||||||
address | TRPAddress | Sim | - | Endereço da localidade | - | Tabela abaixo |
Âncora | ||||
---|---|---|---|---|
|
TPRLocality, tipo de dado utilizado nas integrações do TPR | ||||||
---|---|---|---|---|---|---|
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
identifier | String | Sim | 4096 | Identificador |
da localidade. | Texto livre, deve se único dentro da chamada. | " |
Carrefour Vila Mariana" |
country |
String |
Sim |
Se preenchido, deve ser maior ou igual a zero.
Validado de acordo com o campo "capacityCriteria".
Se preenchido, deve ser maior que zero.
Senão, utilizaremos 30 km/h.
Zerado, nulo ou omitido para os cenários de "Frota Ideal".
Se passados valores quebrados apenas a parte inteira será considerada.
Quantidade máxima de paradas de carregamento por viagem.
Se preenchido, deve ser maior que zero;
Se passados valores quebrados apenas a parte inteira será considerada.
Se preenchido, deve ser maior que zero.
Se passados valores quebrados apenas a parte inteira será considerada.
Tabela para validação de campos Boolean.
Verifica se é para contabilizar a distância de retorno a origem na roteirização.
Tabela para validação de campos Bolean.
Se não informado assumiremos "False".
O montante mínimo do tempo de serviço. Caso a soma dos tempos de carregamento e descarregamento não ultrapassem o valor mínimo, este será utilizado.
Valor padrão: 30m
Se preenchido, não pode ser negativo, em Milissegundos.
O montante máximo do tempo de serviço. Caso a soma dos tempos de carregamento e descarregamento ultrapassem o valor máximo, este será utilizado.
Valor padrão: 8h
Se preenchido, não pode ser negativo, em Milissegundos.
Tabela para validação de campos Bolean.
Se não informado assumiremos "False".
TPRMessage: Tipo de dado utilizado nas integrações do TPR
Frota Ideal: A roteirização com a frota ideal, ocorre quando não limitamos as quantidades disponíveis dos veículos que serão utilizados em uma determinada roteirização, definimos apenas os tipos destes, por exemplo:
Dada uma cesta de pedidos com vinte pedidos de 5.000 kg sem janela de coleta ou entrega e os veículos disponíveis são Carretas com capacidade de 25.000 kg e Trucks com capacidade de 10.000 kg:3 | País do endereço. | Fomato ISO 3166-1 alfa-3. | "BRA" | |||
latitude | Double | Sim | Latitude. | Intervalo [-90; 90]. | -23.6114291 | |
longitude | Double | Sim | Longitude. | Intervalo [-180; 180]. | -46.6946795 |
Se eu não limito a quantidade disponível de veículos, o sistema roteirizara quatro viagens com Carretas, e esta é a frota ideal para este cenário;
Se eu limito os veículos disponíveis em duas Carretas e vinte Trucks, o sistema roteirizara sete viagens, duas com Carretas e cinco com Trucks e esta é a melhor frota factível para este cenário, porem não é a frota ideal;
Valor recebido
"true"
false
Anexos | ||
---|---|---|
|