Histórico da Página
Introdução
| draw.io Diagram | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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 roteirização;
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, Assincrona Path: .../v1/ , Método: POST | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| requestDate | 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 | {"Usuario": "Pedro de alcantra", "Perfil": "Analista"} |
| callbackURL | String | Sim | 4096 | URL de Callback | Inicio com "https://" | |
| callbackAuthenticationType | String | Sim | 4096 | Tipos de autenticação: BASIC, NONEone | Texto Livre | 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 | Texto Livre | "PESO" |
| routingInstantType | String | Não | 4096 | Define o instante que a viagens podem ser expedidas. Valor default D+1 "Now" considera a saída como hora 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 | Pedidos a serem otimizados | Tabela abaixo | ||
| vehicles | TPRRoutingvehicles | Sim | Veículos disponíveis para otimização | Tabela abaixo | ||
| restrictions | TRPRoutingRestrictions | Sim | Restriçoes de roteirização | Tabela abaixo | ||
| Âncora | ||||
|---|---|---|---|---|
|
| Âncora | ||||
|---|---|---|---|---|
|
| Âncora | ||||
|---|---|---|---|---|
|
Âncora TPRRoutingResponse TPRRoutingResponse
| TPRRoutingResponse | |
| TPRRoutingResponse |
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 |
Â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" |
Âncora TPRCatErros TPRCatErros
| TPRCatErros | |
| TPRCatErros |
Catálogo de Erros
| Código | Mensagem | Descrição |
|---|---|---|
| TPRRT001 | Input is null | Ao enviar um Payload nulo |
| TPRRT002 | Invalid callback URL | Ao enviar o campo "callBackUrl" sem domínio, protocolo ou com caracteres especiais. |
| TPRRT003 | Invalid client identifier | Ao enviar o Identificador da instalação/cliente TOTVS vazio ou nulo |
| TPRRT004 | Locality is null | Ao enviar alguma Localidade nula |
| TPRRT005 | Invalid Locality identifier | Ao enviar o Identificador da Localidade vazio ou nulo |
| TPRRT006 | Locality latitude is null | Ao enviar a Latitude da Localidade nula |
| TPRRT007 | Locality longitude is null | Ao enviar a Longitude da Localidade nula |
| TPRRT008 | Locality operation is null | Ao enviar o Funcionamento da Localidade nula |
| TPRRT009 | Order is null | Ao enviar algum Pedido nulo |
| TPRRT010 | Invalid Order identifier | Ao enviar o Identificador do Pedido vazio ou nulo |
| TPRRT011 | Invalid order weight | Ao enviar o Peso do Pedido negativo ou nulo |
| TPRRT012 | Invalid order volume | Ao enviar o Volume do Pedido negativo ou nulo |
| TPRRT013 | Vehicle is null | Ao enviar algum Veículo nulo |
| TPRRT014 | Invalid Vehicle identifier | Ao enviar o Identificador de Veículo vazio ou nulo |
| TPRRT015 | Invalid vehicle volume capacity | Ao enviar a Capacidade de Volume do Veículo negativa ou nulo |
| TPRRT016 | Invalid vehicle weight capacity | Ao enviar a Capacidade de Peso do Veículo negativa ou nulo |
| TPRRT017 | Origin and Destination Locality are equals | Ao enviar Localidades iguais como Origem e Destino |
| TPRRT018 | Duplicated Locality identifier is duplicated in diferentes Localities | Ao enviar localidades com identificadores iguais, mas atributos diferentes. |
| TPRRT019 | Duplicated Vehicle identifier is duplicated in diferentes Vehicle | Ao enviar veículoscom identificadores iguais, mas atributos diferentes. |
| TPRRT020 | Order identifier is duplicated | Ao enviar dois pedidos com o mesmo identificador |
| TPRRT021 | Invalid Vehicles | Ao enviar uma lista vazia de Veículos |
| TPRRT022 | Invalid Orders | Ao enviar uma lista vazia de Pedidos |
| TPRRT023 | Origin locality of Order {identificador do Pedido enviado} is Null | Ao enviar um Pedido com a Localidade de Origem nula |
| TPRRT024 | Destination locality of Order {identificador do Pedido enviado} is Null | Ao enviar um Pedido com a Localidade de Destino nula |
Documentações relacionadas
Anexos
| View file | ||||
|---|---|---|---|---|
|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas