Histórico da Página
Introdução
draw.io Diagram | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Sistemas Envolvidos
TOTVS Otimização Logística / TOTVS Roteirização e Entrega
Sistema Externo: ERPs que se conectam ou pretendem se conectar com TOL/TRE
Integração
Escopo
Pré-requisitos instalação/implantação/utilização
Versões mínimas
TOL\TRE: 6.4.0
Protheus: ?
Datasul: ?
Esta integração não demanda instalações ou atualizações adicionais.
Layout de Requisição
publishTransitionRequest, Integração SOAP, Síncrona | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
monitorableSourceId | string | Sim | N/A | Código do monitorável | Deve ser único por tipo |
monitorableType | string | Sim | N/A | Define o tipo de |
monitorável que pode ser TRIP, DOCUMENT, INVOICE, LOAD | ||||
transitions | Não | N/A | Dados da transição |
Âncora | ||||
---|---|---|---|---|
|
transition, tipo de dado utilizado nas integrações do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
monitorableCode | string | Sim | N/A | Código do monitorável | |
monitorableType | string | Sim | N/A | Define o tipo de |
monitorável que pode ser TRIP, DOCUMENT, INVOICE e LOAD | |
locality |
Não | N/A | Local da transição |
name | string | Sim | N/A | Nome da transição | |
serviceSequence | int | Sim | N/A | Sequencia de paradas | |
expectedTimestamp | dateTime | Sim | N/A | Data/Hora esperada para a transição | |
limitTimestamp | dateTime | Não | N/A | Data/Hora limite para a transição | |
estimatedTimestamp | dateTime | Não | N/A | Data/Hora estimada para a transição | |
executedTimestamp | dateTime | Não | N/A | Data/Hora em que a transição foi executada | |
status | string | Sim | N/A | Status da transição pode ser FINALIZED, IN_EXECUTION e NOT_ACCOMPLISHED | |
extensions | Não | N/A | Dados adicionais específicos de cada implementação |
comments | Não | N/A |
Comentários de |
transições |
Âncora | |||
---|---|---|---|
| |||
|
localityType, tipo de dado utilizado nas integrações do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
locality |
Não | N/A | Localidade |
onde a transição será efetuada | |
address |
Não | N/A | Endereço |
onde a transição será efetuada |
Âncora | |||
---|---|---|---|
| |||
|
entityDto, tipo de dado utilizado nas integrações do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
sourceId | string | Sim | N/A | Código da entidade | |
name | string | Não | N/A | Nome da entidade | |
description | string | Não | N/A | Descrição da entidade |
Âncora | ||||
---|---|---|---|---|
|
address, tipo de dado utilizado nas integrações do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo |
Obrigatório | Tamanho | Descrição | Observações |
---|---|---|---|
street | String | Sim |
N/A |
Rua do endereço | |||
street | String | Sim | N/A |
Rua do endereço | |||
number | String | Não | N/A |
Número do endereço | |||
complement | String | Não | N/A |
Complemento do endereço | |||
district | String | Não | N/A |
Bairro do endereço | |||
city | String | Não | N/A |
Cidade do endereço | ||
state | String | Não |
N/A |
Estado do endereço |
country | String | Não | N/A |
Pais do endereço | |||
zipCode | String | Sim | N/A |
CEP do endereço |
geolocation |
Não | N/A | Latitude e Longitude |
Âncora geolocation geolocation
geolocation, tipo de dado utilizado nas integrações do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
latitude | double | Não | N/A | Latitude do endereço | |
longitude | double | Não | N/A |
Longitude do endereço |
Âncora extension extension
extension, tipo de dado utilizado nas integrações do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
key | String | Sim | N/A | Descrição da extensão | |
textValue | String | Não | N/A | Opção para quando a extensão é uma string | |
floatValue | double | Não | N/A |
Opção para quando a extensão é valor | |||||
integerValue | long | Não | N/A | Opção para quando a extensão é um valor inteiro | |
instantValue | datetime | Não | N/A | Opção para quando a extensão é uma data e hora | |
booleanValue | boolean | Não | N/A |
Opção para quando a extensão é uma lógica |
Âncora | ||||
---|---|---|---|---|
|
comment, tipo de dado utilizado nas integrações do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
user | string | sim | N/A | Usuário do comentário | |
content | string | sim | N/A | Conteúdo do comentário | |
attachmentLink | string | não | N/A | Link para o anexo |
Layout de Resposta
publishTransitionResponse, tipo de dado utilizado nas integrações do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
messages | Não | N/A | Lista de respostas |
Âncora | ||||
---|---|---|---|---|
|
message, tipo de dado utilizado nas integrações do TOL\TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
sourceId | string | Sim | N/A | Código do monitorável | Deve ser único por tipo |
type | string | Sim | N/A | Define o tipo de |
monitorável que pode ser TRIP, DOCUMENT, INVOICE e LOAD | |||||
result | boolean | Sim | N/A | Confirmação do sucesso ou falha do processo | |
string | Não | N/A | Código do erro | ||
description | string | Não | N/A | Descrição do erro |
Catalogo de mensagens
Âncora | ||||
---|---|---|---|---|
|
Código | Mensagem | Descrição |
Anexos
Anexos