Histórico da Página
Introdução
| draw.io Diagram | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Sistemas Envolvidos
TPR:
TOTVS Planejamento de Rotas.
Sistema Externo:
Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico TOTVS.
Integração
- Formato de entrada/saída: JSON
Pré-requisitos instalação/implantação/utilização
- Para clientes Protheus versão xxxxxx;
- Para clientes Datasul versão xxxxxx;
- Para todos os clientes, contratação do trial via TOTVS Store.
Layout de Requisição
TPRRouting: Integração rest, Assíncrona Path: .../v1/ , Método: POST | ||||||
|---|---|---|---|---|---|---|
| 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== |
| capacityCriteria | String | Sim | 4096 | Tipos de roteirização: WEIGHT, VOLUME ou BOTH | Opções: WEIGHT, VOLUME ou BOTH. | "WEIGHT" |
| routingInstantType | String | Não | 4096 | Define o instante em que a viagens podem ser expedidas. Valor default D+1 "Now" considera a saída como hora do servidor no momento da roteirização + 1 hora "D+1" Primeiro horário factível na origem de acordo com o funcionamento da mesma | Valores: "D+1", "NOW". | "NOW" |
| orders | TPRRoutingOrders[] | Sim | Lista de pedidos a serem roteirizados | Tabela abaixo | ||
| vehicles | TPRRoutingVehicles[] | Sim | Lista de veículos disponíveis para a roteirização | Tabela abaixo | ||
| restrictions | TRPRoutingRestrictions[] | Sim | Restrições de roteirização | Tabela abaixo | ||
| Âncora | ||||
|---|---|---|---|---|
|
| TPRRoutingOrders, 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 pedido | Texto livre; Ú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, e; | 25000 | |
| volume | Double | Não | Volume total dos itens do pedido em metros cúbicos | Se preenchido, deve ser maior ou igual a zero; | 5000 | |
| pickupTimeWindowStart | Date Time | Não | Início da janela de carregamento | Formato ISO8601; PickupStart deve ser anterior ou igual a DeliveryStart , se ambos forem preenchidos. PickupStart deve ser anterior a DeliveryEnd se ambos forem 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 | Não | Final da janela de entrega | Formato ISO8601; DeliveryEnd deve vir posterior de posterior ou igual de PickupEnd se ambos forem preenchidos. DeliveryEnd deve vir posterior de DeliveryStart se ambos forem preenchidos. | "2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD" | |
| serviceLoadDuration | Long | Não | Se não informado, será considerado um serviço de 30 minutos | Se preenchido, deve ser maior que zero, em Milissegundos. | 3600000 [ms] | |
| serviceUnloadDuration | Long | Não | Se não informado, será considerado um de 30 minutos | Se preenchido, deve ser maior que zero, em Milissegundos. | 3600000 [ms] | |
| origin | TPRRoutingLocality | Sim | Localidade de origem do pedido | - | Tabela abaixo | |
| destination | TPRRoutingLocality | Sim | Localidade de destino do pedido | - | Tabela abaixo | |
| Âncora | ||||
|---|---|---|---|---|
|
| TPRRoutingLocality, 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. | "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, BUSINESS_DAYS, MORNING, AFTERNOON. | BUSINESS_DAYS | |
| Âncora | ||||
|---|---|---|---|---|
|
| TPRRoutingVehicles, 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 viagem extra; Sempre será escolhido para as viagens extras os veículos que minimizem o número de viagens. | Texto livre. | "Truck" "Carreta" |
| weightCapacity | Double | Sim | Capacidade do veículo em quilos | Se preenchido, deve ser maior ou igual a zero, e; | 25000 | |
| volumeCapacity | Double | Sim | Capacidade do veículo em metros cúbicos | Se preenchido, deve ser maior ou igual a zero, e; Validado de acordo com o campo "capacityCriteria". | 5000 | |
| quantity | Int | Não | Quantidade de veículos, semelhantes a este, disponíveis | Se preenchido, deve ser maior ou igual a zero; Omitido para os cenários de "Frota Ideal". | ||
| Âncora | ||||
|---|---|---|---|---|
|
| TPRRoutingRestrictions, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| maxLoadingStops | Int | Não | 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. | 1 | |
| maxUnloadingStops | Int | Não | Quantidade máxima de paradas de descarregamento por viagem. | Se preenchido, deve ser maior que zero. Se passados valores quebrados apenas a parte inteira será considerada. | 15 | |
| allowInterleaving | Boolean | Não | Permite carregamento após descarregamento na mesma viagem. Default: false | Tabela para validação de campos Bolean: true = true | ||
| maxDistanceBetweenLoadStops | Double | Não | Máxima distância, em km, entre paradas de carregamento; | Se preenchido, deve ser maior que zero. | 100 | |
| maxDistanceBetweenUnloadStops | Double | Não | Máxima distância, em km, entre paradas de descarregamento; | Se preenchido, deve ser maior que zero. | 100 | |
Âncora TPRRoutingResponse TPRRoutingResponse
| TPRRoutingResponse | |
| TPRRoutingResponse |
Layout de Resposta
| TPRRoutingResponse, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| responseDate | Date Time | Sim | Data do envio da resposta no TPR | - | 2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD | |
| version | String | Sim | 4096 | Versão do TPR que executou a resposta | - | 0.0.0.1 |
| success | Boolean | Sim | True se sucesso, false se falha | Se uma única validação falhar, todo o pacote falha. | True | |
| message | TPRMessage[] | Sim | Lista de mensagens a serem exibidas pelo sistema externo para o usuário | - | ||
Âncora TPRMessage TPRMessage
| TPRMessage | |
| TPRMessage |
TPRMessage: Tipo de dado utilizado nas integrações do TPR | ||||||
| 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 válido. | TPR0001 |
| message | String | Sim | 4096 | Mensagem escrita | Texto Livre. | "Para finalizar o cadastro, acesse seu e-mail e valide o Token" |
Âncora TPRCatMsg TPRCatMsg
| TPRCatMsg | |
| TPRCatMsg |
Catálogo de Mensagens
| Código | Mensagem | Descrição |
|---|---|---|
| TPRRT0000 | Sucesso | Sucesso |
| TPRRT0001 | O input é nulo | Ao enviar um payload nula |
| TPRRT0002 | O input é vazio | Ao enviar um payload vazio |
| TPRRT0003 | Data de criação está nula | Ao enviar campo "dataCall" nula |
| TPRRT0004 | A versão [VERSÃO_ENVIADA] possui mais de 4096 caracteres | Ao enviar o campo "version" com mais de 4096 caracteres |
| TPRRT0005 | A chave [CHAVE_ENVIADA] do qualificador possui mais de 4096 caracteres | Ao enviar o campo "qualifiers" que possui uma chave com mais de 4096 caracteres |
| TPRRT0006 | O identificador do sistema externo [IDENTIFICADOR_EXTERNO_ENVIADO] possui mais de 4096 caracteres | Ao enviar o campo "system" com mais de 4096 caracteres |
| TPRRT0007 | A url de callback está nula | Ao enviar o campo "callbackUrl" nula |
| TPRRT0008 | A url de callback está inválida | Ao enviar o campo "callbackUrl" inválida |
| TPRRT0009 | O tipo da callback [URL_CALLBACK] possui mais de 4096 caracteres | Ao enviar o campo "callbackUrl" com mais de 4096 caracteres |
| TPRRT0010 | O tipo da callback está nula | Ao enviar o campo "callbackAuthenticationType" nulo |
| TPRRT0011 | O valor da callback [TIPO_CALLBACK_ENVIADO] possui mais de 4096 caracteres | Ao enviar o campo "callbackAuthenticationType" com mais de 4096 caracteres |
| TPRRT0012 | O tipo da callback [TIPO_CALLBACK_ENVIADO] está inválido. Os valores esperados são 'BASIC' e 'NONE'" | Ao enviar o campo "callbackAuthenticationType" inválido |
| TPRRT0013 | O valor da callback [TIPO_CALLBACK_ENVIADO] possui mais de 4096 caracteres | Ao enviar o campo "callbackAuthenticationType" com mais de 4096 caracteres |
| TPRRT0014 | A url de callback está nula | Ao enviar o campo "capacityCriteria" nula |
| TPRRT0015 | O tipo de roteirização [TIPO_ROTEIRIZAÇÃO] possui mais de 4096 caracteres | Ao enviar o campo "capacityCriteria" com mais de 4096 caracteres |
| TPRRT0016 | O tipo de roteirização [TIPO_ROTEIRIZAÇÃO_ENVIADO] está inválido. Os valores possíveis são 'WEGHT', 'VOLUME' e 'BOTH' | Ao enviar o campo "capacityCriteria" com valores diferentes de WEIGHT, VOLUME E BOTH |
| TPRRT0017 | O instante de expedição [INSTANTE_ROTEIRIZAÇÃO_ENVIADO] possui mais de 4096 caracteres | Ao enviar o campo "routingInstantType" com mais de 4096 caracteres |
| TPRRT0018 | A restrição está nula | Ao enviar o campo "restriction" nula |
| TPRRT0019 | A localidade está nula | Ao enviar alguma localidade nula |
| TPRRT0020 | O identificador da localidade está inválido | Ao enviar o Identificador da Localidade vazio ou nulo |
| TPRRT0021 | A latitude da localidade está nula | Ao enviar a latitude da localidade nula |
| TPRRT0022 | A longitude da localidade está nula | Ao enviar a longitude da localidade nula |
| TPRRT0023 | A operação da localidade está nula | Ao enviar o funcionamento da localidade nula |
| TPRRT0024 | País da localidade com o identificador [IDENTIFICADOR_LOCALIDADE] está nulo | Ao enviar o campo "country" da localidade nulo |
| TPRRT0025 | O identificador da localidade [IDENTIFICADOR_LOCALIDADE] possui mais de 4096 caracteres | Ao enviar o campo "identifier" da localidade com mais de 4096 caracteres |
| TPRRT0026 | O país [PAIS_ENVIADO] está inválido. O mesmo deve seguir o formato ISO 3166-1 alfa-3 | Ao enviar o campo "country" com mais de 3 caracteres |
| TPRRT0027 | O país [PAIS_ENVIADO] não está cadastrado | Ao enviar o campo "country" que não está informado no TPRCountry |
| TPRRT0028 | Latitude [LATITUDE_ENVIADO] está inválido a mesma precisa estar dentro do intervalo [-90; 90] | Ao enviar o campo "latitude" não seguindo o padrão [-90; 90] |
| TPRRT0029 | Longitude [LONGITUDE_ENVIADO] está inválido a mesma precisa estar dentro do intervalo [-180; 180] | Ao enviar o campo "longitude" não seguindo o padrão [-180; 180] |
| TPRRT0030 | Quantidade de veículos deve ser maior que 0 | Ao enviar a quantidade de veículos menor que 0 |
| TPRRT0031 | O pedido está nulo | Ao enviar algum pedido nulo |
| TPRRT0032 | Pedidos inválidos | Ao enviar o campo pedido vazio |
| TPRRT0033 | O identificador do pedido é obrigatório | Ao enviar o identificador do pedido vazio ou nulo |
| TPRRT0034 | O peso do pedido com identificador [PESO_ENVIADO] é obrigatório | Ao enviar o peso do pedido nulo, caso o campo "capacityCriteria" do input seja "WEIGHT" ou "BOTH" |
| TPRRT0035 | O peso do pedido com identificador [PESO_ENVIADO] deve ser maior que 0 | Ao enviar o peso do pedido que seja menor que 0, caso o campo "capacityCriteria" do input seja "WEIGHT" ou "BOTH" |
| TPRRT0036 | O volume do pedido com identificador [VOLUME_ENVIADO] é obrigatório | Ao enviar o campo "volume" menor que 0, caso o campo "capacityCriteria" do input seja "VOLUME" ou 'BOTH" |
| TPRRT0037 | O volume do pedido com identificador [VOLUME_ENVIADO] deve ser maior que 0" | Ao enviar o campo "volume" menor que 0. caso o campo "capacityCriteria" do input seja "VOLUME" |
| TPRRT0038 | A localidade de origem do pedido [IDENTIFICADOR_PEDIDO] está nulo | Ao enviar a localidade de origem do pedido nula |
| TPRRT0039 | A localidade de destino do pedido [IDENTIFICADOR_PEDIDO] está nulo | Ao enviar a localidade de destino do pedido nula |
| TPRRT0040 | O identificador do pedido [IDENTIFICADOR_PEDIDO] possuí mais de 4096 caracteres | O campo "identifier" do pedido com mais de 4096 |
| TPRRT0041 | Duração de serviço de carregamento não pode ser menor ou igual a 0 | Ao enviar o campo "serviceLoadDuration" menor que 0 |
| TPRRT0042 | Duração de serviço de descarregamento não pode ser menor ou igual a 0 | Ao enviar o campo "serviceUnloadDuration" menor que 0 |
| TPRRT0043 | O veículo está nulo | Ao enviar o campo "vehicles" nulo |
| TPRRT0044 | Veículos inválidos | Ao enviar o campo "vehicles" vazio |
| TPRRT0045 | O identificador do veículo está inválido | Ao enviar o campo "identifier" do veículo nulo ou vazio |
| TPRRT0046 | A capacidade de volume do veículo com identificador [IDENTIFICADOR_ENVIADO] é obrigatório | Ao enviar o campo "volumeCapacity" do veículo nula, quando o capacityCriteria é igual a VOLUME ou BOTH |
| TPRRT0047 | A capacidade de volume do veículo com identificador [VOLUME_ENVIADO] deve ser maior que 0 | Ao enviar o campo "volumeCapacity" do veículo é menor que 0, quando o capacityCriteria é igual a VOLUME ou BOTH |
| TPRRT0048 | A capacidade de peso do veículo com identificador [WEIGHT_ENVIADO] é obrigatório | Ao enviar o campo "weightCapacity" do veículo nula, quando o capacityCriteria é igual a WEIGHT ou BOTH |
| TPRRT0049 | A capacidade de peso do veículo com identificador [WEIGHT_ENVIADO] deve ser maior que 0 | Ao enviar o campo "weightCapacity" do veículo é menor que 0, quando o capacityCriteria é igual a WEIGHT ou BOTH |
| TPRRT0050 | O identificador do veículo [IDENTIFICADOR_ENVIADO] possuí mais de 4096 caracteres | Ao enviar o identificador de veículo com mais de 4096 caracteres |
| TPRRT0051 | A quantidade de veículos se informada deve ser maior que 0 | Ao enviar o campo "quantity" menor que 0 |
| TPRRT0052 | O identificador do pedido [IDENTIFICADOR_ENVIADO] está duplicado | Ao enviar dois pedidos com o mesmo identifier |
| TPRRT0053 | A localidade de origem e destino são iguais" | Ao enviar uma localidade de origem e de destino com o mesmo identifier |
| TPRRT0054 | O identificador da localidade [IDENTIFICADOR_ENVIADO] está duplicado em outras localidades | Ao enviar duas localidades quaisquer com o mesmo identifier |
| TPRRT0055 | O identificador do veículo [IDENTIFICADOR_ENVIADO] está duplicado em outros veículo | Ao enviar veículos com identificadores iguais, mas atributos diferentes |
| TPRRT0056 | A chave [CHAVE_ENVIADA] do qualificador possui mais de 4096 caracteres | Ao enviar o campo "qualifiers" que possui um valor com mais de 4096 caracteres |
| TPRRT0057 | O máximo número de paradas de carregamento [PARADAS_CARREGAMENTO_ENVIADA] não pode ser menor ou igual a 0 | Ao enviar o campo "maxLoadingStops" com o valor menor ou igual a 0 |
| TPRRT0058 | O máximo número de paradas de descarregamento [PARADAS_DESCARREGAMENTO_ENVIADA] não pode ser menor ou igual a 0 | Ao enviar o campo "maxUnloadingStops" com o valor menor ou igual a 0 |
| TPRRT0059 | A máxima distância de paradas de carregamento [DISTANCIA_CARREGAMENTO_ENVIADA] não pode ser menor que 0 | Ao enviar o campo "maxDistanceBetweenLoadStops" com o valor menor a 0 |
| TPRRT0060 | A máxima distância de paradas de carregamento [DISTANCIA_DESCARREGAMENTO_ENVIADA] não pode ser menor que 0 | Ao enviar o campo "maxDistanceBetweenUnloadStops" com o valor menor a 0 |
| TPRRT0061 | O pedido [IDENTIFICADOR_ENVIADO] possuí início da janela de carregamento maior que o final da janela de carregamento | Ao enviar o campo "pickupTimeWindowStart" maior que o campo "pickupTimeWindowEnd" |
| TPRRT0062 | O pedido [IDENTIFICADOR_ENVIADO] possuí início da janela de descarregamento maior que o final da janela de descarregamento | Ao enviar o campo "deliveryTimeWindowStart" maior que o campo "deliveryTimeWindowEnd" |
| TPRRT0063 | O peso do veículo [PESO_VEÍCULO] ultrapassou o máximo permitido. Peso constatado [PESO_CONTRATADO] Peso máximo [PESO_MAXIMO] | Quando o peso máximo do veículo ultrapassa o peso permitido pelo validador MaxWeightVehicleServiceLegValidator |
| TPRRT0064 | O volume do veículo [VOLUME_VEÍCULO] ultrapassou o máximo permitido. Volume constatado [VOLUME_CONTRATADO]. Volume máximo [VOLUME_MAXIMO] | Quando o volume máximo do veículo ultrapassa o volume permitido no validador MaxVolumeVehicleServiceLegValidator |
| TPRRT0064 | Não foi possível satisfazer a janela de tempo dos pedidos. | Quando a janela de tempo dos pedidos estão infactiveis baseado no validador TimeWindowValidator |
| TPRRT0065 | Não foi possível gerar configuração temporal para a viagem. | Quando a janela de tempo dos pedidos estão infactiveis baseado no validador PlanTimeConfigurationValidatorWrapper |
Documentações relacionadas
| Âncora | ||||
|---|---|---|---|---|
|
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:
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; |
Anexos
| Anexos | ||
|---|---|---|
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas