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 JSON, para maiores detalhes consulte os Exemplos.
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 do Callback
TPRRoutingCallback: Integração rest, Assincrona Path: ver campo TPRrouting/CallbackURL, Método: POST | ||||||
|---|---|---|---|---|---|---|
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
dateCall | Date Time | Sim | Data do envio da resposta no TPR | Formato ISO8601 | 2021-01-21T10:01:00.0-03:00 | |
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 | Sim | |||||
tripsResults | Sim | Lista de viagens 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 | ||
| Âncora | ||||
|---|---|---|---|---|
|
| TPRSummary, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| totalDistance | double | Sim | Distância total do plano de viagens, em km | Maior ou igual a zero | 3022 [km] | |
| totalTrips | integer | Sim | Quantidade total de viagens do plano | Maior ou igual a zero | 43 [Viagens] | |
| totalStops | integer | Sim | Quantidade total de paradas do plano de viagens | Maior ou igual a zero | 239 [Paradas] | |
| totalVolume | double | Sim | Volume total em viagens, em m³ | Maior ou igual a zero | 50.000 [m³] | |
| totalWeight | double | Sim | Peso total em viagens, em kg | Maior ou igual a zero | 2.500.000 [kg] | |
| totalDuration | double | Sim | Duração total do plano de viagens, em milissegundos | Maior ou igual a zero | 57600000 [ms] | |
| rejectedOrders | integer | Sim | Quantidade de pedidos rejeitados | Maior ou igual a zero | 10 [Pedidos] | |
| rejectedWeight | double | Sim | Total de peso rejeitado, em kg | Maior ou igual a zero | 2.500.000 [kg] | |
| rejectedVolume | double | Sim | Total de volume rejeitado, em m³ | Maior ou igual a zero | 50.000 [m³] | |
| Âncora | ||||
|---|---|---|---|---|
|
| TPRTrip, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| distance | double | Sim | Distancia total planejada para a viagem em km | 123 [km] | ||
| tollValue | double | Sim | Valor do pedágio | Depende do campo tollCalculation | 120,32 [R$] | |
| numberOfStops | integer | Sim | Quantidade total de paradas (carregamentos e descarregamentos) da viagem | |||
| volume | double | Sim | Volume total na viagem, em m³ | 14.32 [m³] | ||
| weight | double | Sim | Peso total na viagem, em kg | 12000 [kg] | ||
| duration | double | Sim | Duração total planejada para a viagem em horas, minutos e segundos | Maior que zero em Millesegundos | 3600000 [ms] | |
| extraTrip | Boolean | Sim | True se o veiculo disponível, false se não disponível; | |||
| considerReturnDistance | Boolean | Não | Informa se a distancia de retorno a origem na roteirização foi contabilizada. | Tabela para validação de campos Boolean. | ||
| vehicle | String | Sim | Identificador do veículo selecionado para a viagem | |||
| stops | TPRTripStop[] | Sim | Lista de paradas | Tabela abaixo | ||
| Âncora | ||||
|---|---|---|---|---|
|
| 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 | ||
| stopType | String | Sim | LOAD, UNLOAD, BOTH | - | ||
| locality | Callback da roteirização - JsonTPRRoutingLocality | Sim | Identificador da localidade | Texto Livre | "Carrefour vila Mariana" | |
| arrivalTime | DateTime | Sim | Horário de chegada | Formato ISO | 2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD | |
| departureTime | DateTime | Sim | Horário de saída | Formato ISO | 2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD | |
| loadedOrders | TPRRoutedOrder[] | Sim | Lista de pedidos carregados nequela parada | Tabela abaixo | ||
| unloadedOrders | TPRRoutedOrder[] | Sim | Lista de pedidos descarreagados nequela parada | 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 | ||||
|---|---|---|---|---|
|
| TPRRejection, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| message | TPRMessage[] | Sim | 4096 | |||
| orders | TRPRoutedOrder[] | Sim | ||||
| Âncora | ||||
|---|---|---|---|---|
|
| TPRRoutedOrder, 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 | "Entrega Carrefour" "PED00133" |
| weight | Double | Não | Peso total os itens do pedido, em kg | Se não tiver peso tem que ter volume; Todos os pedidos da roteirização devem ter o mesmo limitador (Peso ou Volume); | 25.000 | |
| 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); | 5000 | |
Â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 valido | TPR0001 |
| message | String | Sim | 4096 | Mensagem escrita | Texto Livre | "Para finalizar o cadastro acesse seu e-mail e valide o Token" |
| Informações | ||
|---|---|---|
| ||
| Não esperamos corpo na resposta para os callbacks, este, será avaliado apenas pelo HTTP status e este deve determinar o sucesso do envio. |
| Anexos | ||
|---|---|---|
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas