IMPORTANTE
- A integração TOTVS OMS x TOTVS Planejamento de Rotas (TPR) será descontinuada no próximo release (Outubro/2023).
Introdução
Sistemas Envolvidos
- TPR: Front end do TOTVS Planejamento de Rota.
Integração
- Formato Excel e 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 de Requisição
TPR | ||||||
|---|---|---|---|---|---|---|
Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| orders | TPROrders[] | Sim | Lista de pedidos a serem roteirizados. | - | Tabela abaixo | |
| localities | TPRLocality[] | Sim | Localidades dos pedido. | - | Tabela abaixo | |
| TPROrders, tipo de dado utilizado nas integrações do Front-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 | 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] | |
| serviceUnloadDuration | Long | Nã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] | |
| origin | String | Sim | Identificador da localidade de origem do pedido. | - | Tabela abaixo | |
| destination | String | Sim | Identificador da localidade de destino do pedido. | - | Tabela abaixo | |
| 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" |
| operation | 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 | |
| address | TRPAddress | Sim | - | Endereço da localidade. | - | Tabela abaixo |
| TPRAddress, 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 | Pais do endereço. | Formato ISO 3166-1 alfa-3 | "BRA" |
| state | String | Não | 2 | Estado do endereço. | Quando Brasil valida as 27 opções, se informado | SP |
| city | String | Não | 4096 | Cidade do endereço. | Texto livre | Bauru |
| zipCode | String | Não | 4096 | CEP do endereço. | Valida formato, se informado e se BRA | 17047-001 |
| address | String | Sim | 4096 | Rua, número, Bairro e complemento do endereço. | Texto livre | Gomes de carvalho, 940 |
| latitude | Double | Sim | Latitude do endereço. | Intervalo [-90; 90]. | -23.6114291 | |
| longitude | Double | Sim | Longitude do endereço. | Intervalo [-180; 180]. | -46.6946795 | |
Anexos
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas