TOTVS Roteirização e Entregas

Versões comparadas

Versão antiga 3

changes.mady.by.user Julio Vinicius Oliveira dos Santos

Gravado em

comparado com

Nova versão 4

changes.mady.by.user Julio Vinicius Oliveira dos Santos

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Introdução

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

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

publishTransition, Integração SOAP, Síncrona

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

monitorableSourceId

string

Sim

N/A

Código do monitorável


monitorableType

string

Sim

N/A

Define o tipo de documento que pode ser TRIP, DOCUMENT, INVOICE, LOAD


transitions

transition[]

Não

N/A

Dados da transição

Tipo complexo detalhado no link

Âncora
transition
transition

transition, tipo de dado utilizado nas integrações do 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 documento que pode ser TRIP, DOCUMENT, INVOICE e LOAD


locality

localityType[]

Não

N/A

Local da transição

Tipo complexo detalhado no link

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

extension[]

Não

N/A

Dados adicionais específicos de cada implementação

Tipo complexo detalhado no link

comments

comment[]

Não

N/A

Local de abertura de ocorrência

Tipo complexo detalhado no link

Âncora
localityType
localityType

localityType, tipo de dado utilizado nas integrações do TRE

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

locality

entityDto[]

Não

N/A

Localidade do endereço

Tipo complexo detalhado no link

address

address[]

Não

N/A

Endereço para geocodificação

Tipo complexo detalhado no link

Âncora
entityDto
entityDto

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
address
address

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

Numero 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

geolocation[]

Não

N/A

Latitude e Longitude


Âncora
geolocation
geolocation

geolocation, tipo de dado utilizado nas integrações do TRE

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

latitudedoubleNãoN/ALatitude do endereço
longitudedoubleNãoN/ALongitude do endereço

Âncora
extension
extension

extension, tipo de dado utilizado nas integrações do TRE

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

keyStringSimN/ADescrição da extensão
textValueStringNãoN/AOpção para quando a extensão é uma string
floatValuedoubleNãoN/AOpção para quando a extensão é valor
integerValuelongNãoN/AOpção para quando a extensão é um valor inteiro
instantValuedatetimeNãoN/AOpção para quando a extensão é uma data e hora
booleanValuebooleanNãoN/AOpção para quando a extensão é uma lógica

Âncora
comment
comment

comment, tipo de dado utilizado nas integrações do TRE

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

Layout de Resposta

publishTransitionResponse, tipo de dado utilizado nas integrações do TRE

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

messages

message[]

Não

N/A

Lista de respostas

Tipo complexo detalhado no link

Âncora
message
message

publishTransitionResponse, 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 por tipo

type

string

Sim

N/A

Define o tipo de documento que pode ser TRIP, DOCUMENT, INVOICE e LOAD


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
catmsg
catmsg

Anexos

Anexos