TOTVS Roteirização e Entregas

Árvore de páginas

Versões comparadas

Versão antiga 4

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

Gravado em

comparado com

Nova versão Atual

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

draw.io Diagram
borderfalse
viewerToolbartrue
fitWindowfalse
pageId607602837
diagramDisplayName
lboxtrue
diagramNameTRE

Liberacaa

_

de

Liberacao_viagem
simpleViewerfalse
width
linksauto
tbstylehidden
diagramWidth480

Sistemas EnvolvidosEnvolvidos 

  • 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

Integração assíncrona composta pelos serviços de publicação de viagens e desbloqueio de viagens:

  • Se a tag orderBreakParts vier vazia, não existem quebras (splits) para as viagens enviadas na interface;
  • Se a tag orderBreakParts vier preenchida, significa que existem viagens nesta interface que possuem quebras (splits); se isto ocorrer, deve-se identificar, dentro desta estrutura, os pedidos de transporte que sofreram quebras através dos seguintes campos:
    • o orderSourceId: Este campo é o identificador do pedido de transporte recebido na interface de pedidos; se um pedido de transporte está dentro da estrutura orderBreakParts significa que esta sofreu quebra;
    • o orderItemSourceId: Este campo é o identificador do item do pedido de transporte recebido na interface de pedidos;
      • Se um item de pedido de transporte está dentro da estrutura orderBreakParts significa que este item (que está dentro do pedido orderSourceId) sofreu quebra;
    • O campo loadId que existe dentro da estrutura orderBreakParts serve para associar o pedido de transporte (campos orderSourceId e orderItemSourceId) com a carga gerada pelo TOL\TRE nesta interface;
    • As quantidades atualizadas pelo TOL\TRE após as quebras devem ser obtidas nos campos: quantShipmUnits; o quantProdUnits;

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

Âncora
doUnblockReleasedTrip
doUnblockReleasedTrip

doUnblockReleasedTrip: Integração SOAP, Assíncrona com a publishReleasedTrip;
NomeTipoObrigatórioTamanhoDescriçãoObservações
unblockReleasedTripsunblockReleasedTrips[]SimN/AElemento de agrupamento de todas as solicitações de desbloqueio de viagens;

Âncora
unblockReleasedTrips
unblockReleasedTrips

unblockReleasedTrip, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
unblockReleasedTripsunblockReleasedTrip[]SimN/AElemento de agrupamento de todas as solicitações de desbloqueio de viagens;
Âncora
unblockReleasedTrip
unblockReleasedTrip
unblockReleasedTrip, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
identifier (unblock release trip)
Numérico (inteiro)
IntegerSim10ID da mensagem de solicitação de liberação da viagem;

Este campo deve ser de uma mensagem de solicitação de liberação de viagem válida ou -1 quando ocorrer algum erro no sistema externo ao tentar recriar as viagens do

CPL

TOL/TRE (neste caso, a requisição feita neste serviço será ignorada pelo

CPL

TOL/TRE); no caso de erro no sistema externo, o detalhe deste erro pode ser enviado no elemento "ERPMessageResponses";

ERPMessageResponses
(início)
EntidadeNãoN/AEntidade de agrupamento das respostas do sistema externo;eRPMessageResponseList (início)EntidadeeRPMessageResponse (início)Entidade
eRPMessageResponseList[]NãoN/AEntidade de agrupamento das respostas do sistema externo;
ERPMessageResponses (início)ListaSimN/AEntidade de agrupamento das respostas do sistema externo;

orderBreakResponses

orderBreakResponses[]

NãoN/AEntidade de agrupamento de uma resposta do sistema externo
;msgAlfanuméricoSimN/AMensagem de resposta do sistema externo;
para uma quebra do TOL/TRE;Observação: se todas as quebras, menos 1, foram aprovadas, a última será aprovada automaticamente;
tripReleaseResponsestripReleaseResponseList[]Sim
eRPMessageResponse (fim)EntidadeNão
N/A

Entidade de agrupamento de uma resposta do sistema externo

;ERPMessageResponses (fim)ListaSimN/AEntidade de agrupamento das respostas do sistema externo;eRPMessageResponseList (fim)EntidadeNãoN/AEntidade de agrupamento das respostas do sistema externo;ERPMessageResponses (fim)EntidadeNão

para as liberações de uma viagem do TOL/TRE;


tripLoadsSourceIdstripLoadsSourceIdList[]SimN/AEntidade de agrupamento
das respostas do sistema externo;orderBreakRemovalRequests (início)EntidadeNãoN/AEntidade de agrupamento das solicitações
para envio dos source ids das cargas do sistema externo para o
cancelamento das quebras do CPL;Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado;orderBreakRemovalRequestList (início)EntidadeNãoN/AEntidade de agrupamento das solicitações do sistema externo para o cancelamento das quebras do CPL;Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado;orderBreakRemovalRequests (início)ListaSimN/AEntidade de agrupamento das solicitações do sistema externo para o cancelamento das quebras do CPL;Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado;orderBreakRemovalRequest (início)Entidade
TOL/TRE;

Âncora
eRPMessageResponseList
eRPMessageResponseList

eRPMessageResponseList, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
ERPMessageResponseseRPMessageResponse[]SimN/A
Entidade
Elemento de agrupamento de todas as solicitações de desbloqueio de viagens;

Âncora
eRPMessageResponse
eRPMessageResponse

eRPMessageResponse, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
msgString
uma solicitação do sistema externo para o cancelamento de uma quebra do CPL;Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado;identifier (order break removal)AlfanuméricoSim10ID da solicitação do sistema externo para o cancelamento de uma quebra do CPL;Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado;orderBreakIdList (início)EntidadeSimN/AEntidade de agrupamento das quebras do CPL que devem ser canceladas;Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado;orderBreakIdsLista <numérico(inteiro)>Sim10IDs das quebras do CPL que devem ser canceladas;Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado;orderBreakIdList (fim)EntidadeSimN/AEntidade de agrupamento das quebras do CPL que devem ser canceladas;Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado;orderBreakRemovalRequest (fim)Entidade
SimN/A
Entidade de agrupamento de uma solicitação
Mensagem de resposta do sistema externo
para o cancelamento de uma quebra do CPL;Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado;orderBreakRemovalRequests (fim)ListaNãoN/AEntidade de agrupamento das solicitações do sistema externo para o cancelamento das quebras do CPL;Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado;orderBreakRemovalRequestList (fim)EntidadeNãoN/AEntidade de agrupamento das solicitações do sistema externo para o cancelamento das quebras do CPL;Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado;orderBreakRemovalRequests (fim)EntidadeNãoN/AEntidade de agrupamento das solicitações do sistema externo para o cancelamento das quebras do CPL;Deprecated: na operação de "doUnblockReleaseTrip", este campo não é utilizado;orderBreakResponses (início)EntidadeNãoN/AEntidade de agrupamento das respostas do sistema externo para as quebras do CPL;Os desbloqueios das quebras poderão ser enviados de forma gradual (em mensagens distintas); IMPORTANTE: todas as quebras deverão ser desbloqueadas para que a viagem seja liberada;orderBreakResponses (início)ListaSimN/AEntidade de agrupamento das respostas do sistema externo para as quebras do CPL;orderBreakResponse (início)EntidadeNãoN/AEntidade de agrupamento de uma resposta do sistema externo para uma quebra do CPL;Observação: se todas as quebras, menos 1, foram aprovadas, a última será aprovada automaticamente;
;

Âncora
orderBreakResponses
orderBreakResponses

orderBreakResponses, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
orderBreakResponsesorderBreakResponse[]SimN/AElemento de agrupamento de todas as solicitações de desbloqueio de viagens;

Âncora
orderBreakResponse
orderBreakResponse

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

Nome

TipoObrigatórioTamanhoDescriçãoObservações
regionSourceIdString
regionSourceIdAlfanumérico
Sim30Identificador da regional;Deve ser uma regional válida;
breakId
Numérico (inteiro)
IntegerSim10ID da quebra do
CPL
TOL/TRE;

Este campo deve receber um ID de quebra válido; não se deve re-enviar IDs de quebra que já foram liberados; o sistema externo deverá dar um retorno para todos os breakIds gerados pelo

CPL

TOL/TRE na interface de liberação de viagem para que esta seja liberada;

orderId
Alfanumérico
StringSim30ID do pedido de transporte associado à quebra;Importante:
- Caso o sistema externo deseja que esta quebra seja vinculada a um novo pedido, basta informar o nome do novo pedido neste campo; as unidades relacionadas a esta quebra serão associadas ao novo pedido; os dados do novo pedido serão copiados do pedido original;
- Esta alteração do pedido apenas será realizada se o campo status for enviado com o valor "1";
orderItemId
Alfanumérico
StringSim30ID do item do pedido de transporte associado à quebra;Importante:
- Caso o sistema externo deseja que esta quebra seja vinculada a um novo item de pedido, basta informar o nome do novo item pedido neste campo; as unidades relacionadas a esta quebra serão associadas ao novo item de pedido; os dados do novo item de pedido serão copiados do item de pedido original;
- Esta alteração do item do pedido apenas será realizada se o campo status for enviado com o valor "1";
- Se o código do item de pedido for alterado mas o código de pedido permanecer o mesmo do pedido original, a mensagem será rejeitada;
status
Booleano
BooleanSim1Status de resposta do sistema externo sobre a quebra do
CPL
TOL/TRE;0=Quebra não realizada; 1=Quebra realizada;
msg
Alfanumérico
StringNão500Mensagem de resposta do sistema externo sobre a quebra do
CPL
TOL/TRE;

Âncora
tripReleaseResponseList
tripReleaseResponseList

tripReleaseResponseList, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
tripReleaseResponseListtripReleaseResponse[]Sim
orderBreakResponse (fim)EntidadeNãoN/AEntidade de agrupamento de uma resposta do sistema externo para uma quebra do CPL;Observação: se todas as quebras, menos 1, foram aprovadas, a última será aprovada automaticamente;orderBreakResponses (fim)ListaSimN/AEntidade de agrupamento das respostas do sistema externo para as quebras do CPL;orderBreakResponses (fim)EntidadeNão
N/A
Entidade
Elemento de agrupamento
das respostas do sistema externo para as quebras do CPL;Os desbloqueios das quebras poderão ser enviados
de
forma gradual (em mensagens distintas); IMPORTANTE: todas as quebras deverão ser desbloqueadas para que a viagem seja liberada;tripReleaseResponses (início)EntidadeSimN/AEntidade de agrupamento das respostas do sistema externo para as liberações das viagens do CPL;Os desbloqueios dos itens poderão ser enviados de forma gradual (em mensagens distintas); IMPORTANTE: todos os itens deverão ser desbloqueados para que a viagem seja liberada;
todas as solicitações de desbloqueio de viagens;
Âncora
tripReleaseResponse
tripReleaseResponse
tripReleaseResponse, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
regionSourceIdString
tripReleaseResponseList (início)EntidadeSimN/A

Entidade de agrupamento das respostas do sistema externo para as liberações das viagens do CPL;

tripReleaseResponses (início)ListaSimN/A

Entidade de agrupamento das respostas do sistema externo para as liberações das viagens do CPL;

tripReleaseResponse (início)EntidadeSimN/A

Entidade de agrupamento de uma resposta do sistema externo para as liberações de uma viagem do CPL;

regionSourceIdAlfanumérico
Sim30Identificador da regional;Deve ser uma regional válida;
tripCode
Numérico (inteiro)
IntegerSim10ID da viagem do
CPL
TOL/TRE;Este campo deve receber um ID de viagem válido; não se deve enviar IDs de viagens que já foram liberadas;
orderSourceId
Alfanumérico
StringSim30ID do pedido de transporte associado à viagem;Este campo deve receber um ID de pedido válido para a viagem;
itemId
Alfanumérico
StringSim30ID do item do pedido de transporte associado ao pedido da viagem;Este campo deve receber um ID de item de pedido válido para o pedido da viagem; o sistema externo deverá dar um retorno para todos os itens de pedido existentes na viagem para que esta seja liberada;
status
Booleano
BooleanNão1Status de resposta do sistema externo sobre a viagem do
CPL
TOL/TRE;0=Não desbloqueia a viagem; 1=Desbloqueia a viagem; se este campo não for preenchido, ele será considerado como 0;
msg
Alfanumérico
StringNão500Mensagem de resposta do sistema externo sobre a viagem do
CPL
TOL/TRE;
tripReleaseResponses (fim)ListaSimN/A

Entidade de agrupamento das respostas do sistema externo para as liberações das viagens do CPL;

tripReleaseResponse (fim)EntidadeSimN/A

Entidade de agrupamento de uma resposta do sistema externo para as liberações de uma viagem do CPL;

tripReleaseResponseList (fim)EntidadeSimN/A

Entidade de agrupamento das respostas do sistema externo para as liberações das viagens do CPL;


Âncora
tripLoadsSourceIdList
tripLoadsSourceIdList

tripLoadsSourceIdList, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
tripLoadsSourceIdstripLoadsSourceId[]Sim
tripReleaseResponses (fim)EntidadeSimN/AEntidade de agrupamento das respostas do sistema externo para as liberações das viagens do CPL;Os desbloqueios dos itens poderão ser enviados de forma gradual (em mensagens distintas); IMPORTANTE: todos os itens deverão ser desbloqueados para que a viagem seja liberada;tripsLoadsSourceIds (início)EntidadeNão
N/AEntidade de agrupamento para envio dos source ids das cargas do sistema externo para o
CPL
TOL/TRE;

Âncora
tripLoadsSourceId
tripLoadsSourceId

tripLoadsSourceId, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
regionSourceIdString
tripsLoadsSourceIdsList (início)ListaSimN/AEntidade de agrupamento para envio dos source ids das cargas do sistema externo para o CPL;Pelo menos 1 elemento deve ser enviado nesta lista;tripLoadsSourceIds (início)EntidadeSimN/AEntidade de agrupamento para envio dos source ids das cargas do sistema externo para o CPL;regionSourceIdAlfanumérico
Sim30Identificador da regional;Deve ser uma regional válida;
tripId
Numérico (inteiro)
IntegerSim10ID de uma viagem do
CPL
TOL/TRE;
loadsload[]SimN/AElemento de agrupamento de todas as cargas da viagem;Quando enviada, esta seção deverá retornar todas as cargas da viagem;
tripLoadsSourceIds (fim)EntidadeSimN/AEntidade de agrupamento para envio dos source ids das cargas do sistema externo para o CPL;tripsLoadsSourceIdsList (fim)ListaSimN/AEntidade de agrupamento para envio dos source ids das cargas do sistema externo para o CPL;Pelo menos 1 elemento deve ser enviado nesta lista;tripsLoadsSourceIds (fim)EntidadeNãoN/AEntidade de agrupamento para envio dos source ids das cargas do sistema externo para o CPL;unblockReleasedTrip (fim)EntidadeNãoN/AElemento de agrupamento de uma solicitação de desbloqueio de viagem;unblockReleasedTrips (fim)ListaSimN/AElemento de agrupamento de todas as solicitações de desbloqueio de viagens;unblockReleasedTrips (fim)EntidadeSimN/AElemento de agrupamento de todas as solicitações de desbloqueio de viagens;
Âncora

Âncora
load
load

load, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
loadIdIntegerSim10ID da carga da viagem no TOL/TRE;

Estes campos são apenas para que se possa ter uma referência do ID de uma carga do sistema externo no TOL/TRE; se o loadId não for válido (ex.: vazio ou um código inexistente no TOL/TRE) ou estiver associada a uma viagem distinta da informada, o TOL/TRE deverá retornar uma mensagem de erro e a requisição deverá ser ignorada;

loadSourceIdIntegerSim30ID da carga da viagem no sistema externo;

Layout de Resposta

tripLoadsSourceIdList
doUnblockReleasedTripdoUnblockReleasedTrip
unblockReleasedTrip
, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
resultresults[]SimN/AEntidade de agrupamento para envio dos resultados
Âncora
doUnblockReleasedTrip
results
doUnblockReleasedTrip
results
unblockReleasedTrip
results, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
resultsresult[]SimN/AEntidade de agrupamento para envio dos resultados
Âncora
doUnblockReleasedTripresultdoUnblockReleasedTrip
result
unblockReleasedTrip
result, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
ÂncoradoUnblockReleasedTripdoUnblockReleasedTrip
errorCodeserrcode[]NãoN/ALista de erros
errorMessageStringNãoN/AMensgem de erro
identifierStringSimN/AID da mensagem de solicitação de liberação da viagem;
sucessStringSim1TRUE or FALSE
Âncora
errcode
errcode
errcode
unblockReleasedTrip, tipo de dado utilizado nas integrações do TRENomeTipoObrigatórioTamanhoDescriçãoObservações Âncoraloadload
load
, tipo de dado utilizado nas integrações do TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
loadIdNumérico (inteiro)Sim10ID da carga da viagem no CPL;

Estes campos são apenas para que se possa ter uma referência do ID de uma carga do sistema externo no CPL; se o loadId não for válido (ex.: vazio ou um código inexistente no CPL) ou estiver associada a uma viagem distinta da informada, o CPL deverá retornar uma mensagem de erro e a requisição deverá ser ignorada;

loadSourceIdNumérico (inteiro)Sim30ID da carga da viagem no sistema externo;
Layout de Resposta
valueStringNãoN/ACódigo do erro

Catalogo de erros

Anexos

Anexos