Histórico da Página
Introdução
| draw.io Diagram | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Sistemas Envolvidos
TOTVS Roteirização e Entrega
Sistema Externo: Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico da TOTVS.
Integração
Escopo
- Criação de viagem, documento, nota fiscal, itens, motorista, transportadora, dispositivo de rastreamento e dispositivo mobile
Pré-requisitos instalação/implantação/utilização
Versões mínimas
TRE: 6.4.0
Protheus: ?
Datasul: ?
Esta integração não demanda instalações ou atualizações adicionais.
Layout de Requisição
createMonitorable, Integração SOAP, Síncrona | |||||
|---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| driver | Aquisição de monitoravel | Não | N/A | Motorista associado a viagem | |
| alternativeDrivers | Aquisição de monitoravel | Não | N/A | Lista de motoristas alternativos da viagem | |
| trackerDevice | Aquisição de monitoravel | Não | N/A | trackerDevice ou mobileDevice deve ser fornecido para viabilizar o rastreamento | |
| monitorables | Aquisição de monitoravel | Não | N/A | Lista de monitoráveis | |
| relationships | Aquisição de monitoravel | Não | N/A | Lista de relação entre os monitoráveis | |
| Âncora | ||||
|---|---|---|---|---|
|
driver, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| driver | Não | N/A | Motorista da viagem | ||
| identifier | String | Sim | N/A | Identificação do motorista | Ex: Cpf, Matricula |
| user | Aquisição de monitoravel | Não | N/A | Dados de usuário e senha para acesso ao sistema | |
| Âncora | ||||
|---|---|---|---|---|
|
user, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| password | String | Sim | N/A | Senha | |
| String | Sim | N/A | E-mail associado ao usuário | ||
| profile | String | Sim | N/A | Profile de acesso do usuário, ex: root | |
| Âncora | ||||
|---|---|---|---|---|
|
trackerDevice, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| deviceId | string | Sim | N/A | Id do dispositivo | |
| providerID | string | Sim | N/A | Provedor do dispositivo | |
| Âncora | ||||
|---|---|---|---|---|
|
monitorable, tipo de dado utilizado nas integrações do TRE | ||||||
|---|---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações | |
| sourceId | string | Sim | N/A | Código do monitorável | Deve ser único ativo | |
| type | string | Sim | N/A | Define o tipo de monitoravel que pode ser TRIP, DOCUMENT e INVOICE | ||
| origin | complex typeAquisição de monitoravel | Não | N/A | Local de carregamento | Tipo complexo detalhado no link | |
| shipper | complex typeAquisição de monitoravel | Não | N/A | Embarcador do monitorável | Tipo complexo detalhado no link | |
| destination | complex typeAquisição de monitoravel | Não | N/A | Local de descarregamento | Tipo complexo detalhado no link | |
| custumer | complex typeAquisição de monitoravel | Não | N/A | Cliente do monitorável | Tipo complexo detalhado no link||
| carrier | complex typeAquisição de monitoravel | Não | N/A | Transportadora do monitorável | Tipo complexo detalhado no link||
| vehicle | complex typeAquisição de monitoravel | Não | N/A | Veículo do monitorável | Tipo complexo detalhado no link||
| truck | complex typeAquisição de monitoravel | Não | N/A | Placa do monitorável | Tipo complexo detalhado no link | |
| loadingSequence | int | Não | N/A | Sequencia de carregamento | ||
| unloadingSequence | int | Não | N/A | Sequencia de descarregamento | ||
| quantity | int | Não | N/A | Quantidade de volumes do documento | ||
| value | double | Não | N/A | Valor do documento | ||
| volume | double | Não | N/A | Volume do documento | ||
| weight | double | Não | N/A | Peso do documento | ||
| contact | string | Não | N/A | Contato responsável pelo serviço | ||
| Items | complex typeitem[] | Não | N/A | Itens dos monitorizáveis quando elegíveis | Tipo complexo detalhado no link | |
| transitions | complex typetransition[] | Não | N/A | Dados da transição | Tipo complexo detalhado no link | |
| extensions | complex typeextension[] | Não | N/A | Dados adicionais específicos de cada impl | ||
| Âncora | ||||
|---|---|---|---|---|
|
entityDto, tipo de dado utilizado nas integrações do 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 | ||||
|---|---|---|---|---|
|
localityType, tipo de dado utilizado nas integrações do 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 | ||||
|---|---|---|---|---|
|
address, tipo de dado utilizado nas integrações do 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, tipo de dado utilizado nas integrações do 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 | |
items, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| sourceId | String | Sim | N/A | Código do item do monitorável | |
| sequence | int | Não | N/A | Quantidade do item do monitorável | |
| Product | Aquisição de monitoravel | Não | N/A | Produto do item do monitorável | |
| quantity | int | Não | N/A | Quantidade do item do monitorável | |
| value | double | Não | N/A | Valor do item do monitorável | |
| volume | double | Não | N/A | Volume do item do monitorável | |
| weight | double | Não | N/A | Peso do item do monitorável | |
| extensions | extension[] | Não | N/A | Dados adicionais específicos de cada implementação | |
| Âncora | ||||
|---|---|---|---|---|
|
transitionAquisitionType, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| sourceId | string | Sim | N/A | Código da transição | Deve ser único com o monitorável ativo |
| name | string | Sim | N/A | Nome da transição | |
| 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 | |
| location | Aquisição de monitoravel | Não | N/A | Local da transição | |
| extensions | extension[] | Não | N/A | Dados adicionais específicos de cada implementação | |
| Âncora | ||||
|---|---|---|---|---|
|
extension, tipo de dado utilizado nas integrações do 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 | ||||
|---|---|---|---|---|
|
realtionship, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| parentSourceId | string | Sim | N/A | Monitorável Pai | |
| children | string | Sim | N/A | Lista de monitoráveis Filhos | |
| Âncora | ||||
|---|---|---|---|---|
|
childrenType, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| child | string | Sim | N/A | Monitoráveis filhos | |
Layout de Resposta
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| messeges | messegeType[] | Sim | N/A | Lista de respostas |
| Âncora | ||||
|---|---|---|---|---|
|
| messageType, tipo de dado utilizado nas integrações do TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| sourceId | string | Sim | N/A | Código do monitorável | |
| type | string | Sim | N/A | Define o tipo do monitorável que pode ser TRIP, LOAD, DOCUMENT e INVOICE | |
| result | boolean | Sim | N/A | Confirmação do sucesso ou falha do processo | |
| code | 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 |
|---|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas