Introdução
Sistemas Envolvidos
- TPR: Front end do TOTVS Planejamento de Rota.
Integração
- Formato JSON, para maiores detalhes consulte os Exemplos.
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 | Sim | Lista de rotas geradas via otimização | Tabela abaixo | |||
rejections | Não | Lista de rejeites geradas via otimização | Tabela abaixo | |||
message | Não | Campo que deve ser exibido pelo sistema externo para o usuário | - | Tabela abaixo | ||
| TPRTripResults, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| tripId | integer | Sim | Índice incremental gerado a cada rota | 1, 2 ... 99 | ||
| distance | double | Sim | Distância total planejada para a 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 rota | |||
| volume | double | Sim | Volume total na rota, em m³ | 14.32 [m³] | ||
| weight | double | Sim | Peso total na rota, em kg | 12000 [kg] | ||
| duration | double | Sim | Duração total planejada para a rota em milissegundos | Maior que zero em milissegundos | 3600000 [ms] | |
| extraTrip | Boolean | Sim | True/Verdadeiro se o veículo disponível, false/falso se não disponível; | |||
| considerReturnDistance | Boolean | Não | Informa se a distância de retorno a origem na roteirização foi contabilizada. | Tabela para validação de campos Boolean. | ||
| vehicle | TPRVehicle | Sim | Veículo selecionado da rota | |||
| stops | TPRTripStop[] | Sim | Lista de paradas | Tabela abaixo | ||
| 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 | |
| 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" | |
| 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 | ||
| 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 | ||
| 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 | |
| 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 | ||
| 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 | TROrderRejection[] | Sim | ||||
| TPROrderRejection, 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 que gerou o rejeite | "Entrega Carrefour" "PED00133" | |
| Weight | Double | Não | Quantidade rejeitada de peso em kg | 25.000 | ||
| Volume | Double | Não | Quantidade rejeitada de volume em m³ | 5000 | ||
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 | Descrição do motivo do rejeite | Texto Livre | "Para finalizar o cadastro acesse seu e-mail e valide o Token" |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas