Histórico da Página
Introdução
Disponibilizar uma API pública para efetuar roteirização.
Sistemas Envolvidos
- TPR
- 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
Escopo
- Ao enviar um payload válido, será efetuada uma otimização, gerando um jobId para consulta.
Pré-requisitos instalação/implantação/utilização
- Ter um identificador de instalação/cliente TOTVS válido.
Layout de Requisição
| Nome | Tipo | Obrigatoriedade | Tam. Máx. | Formato | Valor default | Descrição | Observações |
| clientIdentifier | String | Sim | N/A | N/A | N/A | Identificador da instalação/cliente TOTVS | |
| option | Object | Não | N/A | N/A | N/A | Opções adicionais | |
| orders | List | Sim | N/A | N/A | N/A | Pedidos a serem otimizados | |
| vehicles | List | Sim | N/A | N/A | N/A | Veículos disponíveis para otimização | |
| OPTION | |||||||
| extension | Map | Não | N/A | N/A | N/A | Campo para inserir opções adicionais | |
| callBackUrl | String | Não | N/A | URL | N/A | URL de callback pós otimização | |
| ORDERS | |||||||
| identifier | Sim | N/A | N/A | N/A | Identificador do pedido | ||
| weight | Sim | N/A | N/A | N/A | Peso do pedido | ||
| volume | Sim | N/A | N/A | N/A | Volume do pedido | ||
| origin | Object | Sim | N/A | N/A | N/A | Localidade de origem do pedido | Segue o contrato de Locality |
| destination | Object | Sim | N/A | N/A | N/A | Localidade de destino do pedido | Segue o contrato de Locality |
| LOCALITY | |||||||
| identifier | String | Sim | N/A | N/A | N/A | Identificador da localidade | |
| latitude | Double | Sim | N/A | N/A | N/A | Latitude da localidade | |
| longitude | Double | Sim | N/A | N/A | N/A | Longitude da localidade | |
| operation | Enum | Sim | N/A | N/A | N/A | Funcionamento simplificado | Opções: IRRESTRIC, COMERCIAL_DAYS |
| VEHICLES | |||||||
| identifier | String | Sim | N/A | N/A | N/A | Identificador do veículo | |
| weightCapacity | Double | Sim | N/A | N/A | N/A | Capacidade de peso | |
| volumeCapacity | Double | Sim | N/A | N/A | N/A | Capacidade de volume | |
Layout de Resposta
| Nome | Tipo | Tam. Máx. | Formato | Valor default | Descrição | Observações |
| success | Boolean | N/A | N/A | N/A | Status da otimização | |
| jobId | Integer | N/A | N/A | N/A | O ID gerado da otimização | Em casos de erro, o jobId não será gerado. |
| message | String | N/A | N/A | N/A | Mensagem de sucesso/falha |
Catálogo de Erros
| Cenário | Mensagem |
|---|---|
| Ao enviar um Payload nulo | Input is null |
| Ao enviar o campo "callBackUrl" sem domínio, protocolo ou com caracteres especiais. | Invalid callback URL |
| Ao enviar o Identificador da instalação/cliente TOTVS vazio ou nulo | Invalid client identifier |
| Ao enviar alguma Localidade nula | Locality is null |
| Ao enviar o Identificador da Localidade vazio ou nulo | Invalid Locality identifier |
| Ao enviar a Latitude da Localidade nula | Locality latitude is null |
| Ao enviar a Longitude da Localidade nula | Locality longitude is null |
| Ao enviar o Funcionamento da Localidade nula | Locality operation is null |
| Ao enviar algum Pedido nulo | Order is null |
| Ao enviar o Identificador do Pedido vazio ou nulo | Invalid Order identifier |
| Ao enviar o Peso do Pedido negativo ou nulo | Invalid order weight |
| Ao enviar o Volume do Pedido negativo ou nulo | Invalid order volume |
| Ao enviar algum Veículo nulo | Vehicle is null |
| Ao enviar o Identificador de Veículo vazio ou nulo | Invalid Vehicle identifier |
| Ao enviar a Capacidade de Volume do Veículo negativa ou nulo | Invalid vehicle volume capacity |
| Ao enviar a Capacidade de Peso do Veículo negativa ou nulo | Invalid vehicle weight capacity |
| Ao enviar Localidades iguais como Origem e Destino | Origin and Destination Locality are equals |
| Ao enviar localidades com identificadores iguais, mas atributos diferentes. | Duplicated Locality identifier is duplicated in diferentes Localities |
| Ao enviar veículoscom identificadores iguais, mas atributos diferentes. | Duplicated Vehicle identifier is duplicated in diferentes Vehicle |
| Ao enviar dois pedidos com o mesmo identificador | Order identifier is duplicated |
| Ao enviar uma lista vazia de Veículos | Invalid Vehicles |
| Ao enviar uma lista vazia de Pedidos | Invalid Orders |
Documentações relacionadas
Anexos
| View file | ||||
|---|---|---|---|---|
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas