Histórico da Página
Introdução
Sistemas Envolvidos
Integração
Escopo
Pré-requisitos instalação/implantação/utilizaçã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
Escopo
A interface PublishReprogrammingService
Layout de Requisição
serve apenas para solicitar ao sistema externo permissão para a reprogramação da carga no
CPLTOL/TRE.
- Para solicitar esta permissão, o
- TOL/TRE irá mandar uma mensagem ao sistema externo através da estrutura
- publishReprogrammingService e o sistema externo deverá retornar uma mensagem de resposta
- ao TOL/TRE na estrutura publishReprogrammingServiceResponse:
- Se o sistema externo retornar um status de que a reprogramação é possível (campo status=0), o
Se o sistema externo retornar um status de que reprogramação não é possível (campo status=1 ou 2 ou 3), o CPL não
- TOL/TRE permitirá ao usuário a alteração da carga.
- Caso o sistema externo retorne que a reprogramação é possível (campo status=0), após a reprogramação da carga no
- TOL/TRE permitirá ao usuário a alteração da carga.
- TOL/TRE, o TOL/TRE irá enviar novamente ao sistema externo (através da interface
- publishReleasedTrip) uma mensagem de publicação de viagens com as alterações feitas pelo usuário na reprogramação.
- Neste cenário, quando o sistema externo permitir a reprogramação da carga, é importante que o sistema externo volte o status do documento de transporte para uma condição que permita uma futura edição pelo
- TOL/TRE (que será feita através da interface publishReleasedTrip).
- Se o sistema externo retornar um status de que reprogramação não é possível (campo status=1 ou 2 ou 3), o TOL/TRE não permitirá ao usuário a alteração da carga.
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 publishReprogrammingService publishReprogrammingService
| publishReprogrammingService, Integração SOAP, Síncrona | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| regionSourceId | String | Sim | 30 | ||
| Identificador da regional; | Deve ser uma regional válida; | |
| basketSourceId |
| String | Não | 30 |
| ID da cesta onde esta operação foi realizada manualmente pelo usuário |
| ; | Este campo poderá não ser enviado nos casos em que a solicitação de reprogramação foi feita de forma automática e não através da tela |
| (nestes casos, não se pode identificar a cesta do usuário); |
| trips | trip[] | Sim |
| N/A | Elemento de agrupamento de todas as viagens do |
| que se quer reprogramar; | Deverá haver pelo menos 1 |
| viagem nesta lista; |
| loads | load[] | Sim |
| N/A |
| Elemento de agrupamento de |
| todas as cargas da viagem; |
Âncora trip trip
| trip, tipo de dado utilizado nas integrações do TOL/TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| tripId | Integer | Sim | 10 | ||
| ID da viagem cuja reprogramação está sendo solicitada |
| ; |
Âncora load load
| load, tipo de dado utilizado nas integrações do TOL/TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| loadId | Integer | Sim | 10 | ||
| Identificador de uma carga da viagem; | |
| loadSourceId |
| String | Não | 30 |
| Identificador externo de uma carga da viagem; |
Layout de Resposta
Âncora publishReprogrammingServiceResponse publishReprogrammingServiceResponse
| publishReprogrammingServiceResponse, tipo de dado utilizado nas integrações do TOL/TRE |
|---|
| Nome | Tipo | ||||
|---|---|---|---|---|---|
| Obrigatório | Tamanho | Descrição | Observações |
|---|
| result | result[] | Sim | N/A |
| Elemento de agrupamento de todas as viagens |
| do que se quer reprogramar com os respectivos status das solicitações; | Deverá haver pelo menos 1 |
| viagem nesta lista; |
| Âncora | ||||
|---|---|---|---|---|
|
| result, tipo de dado utilizado nas integrações do TOL/TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| regionSourceId | String | Sim | 30 | ||
| Identificador da regional; | Deve ser uma regional válida; | |
| tripId |
| Integer | Sim | 10 |
| ID da viagem cuja reprogramação foi solicitada |
| ; | |
| status |
| Integer | Sim | 1 |
| Status da solicitação de reprogramação de viagem |
| ; | 0=Reprogramação autorizada; 1=Viagem cancelada; 2=Viagem não encontrada; 3=Viagem já despachada/Reprogramação não autorizada; Importante: - Se o sistema externo retornar o código 0, a viagem será colocada no seu último status antes da liberação (Observação: notar que alguns destes status podem não permitir a reprogramação |
| Ex.: "Viagem Ofertada"); - Se o sistema externo retornar o código 1, será efetuado o |
| cancelamento da viagem automaticamente |
| . O sistema externo não será novamente notificado |
| ; - Se o sistema externo retornar os códigos 2 ou 3, não será possível reprogramar a viagem |
Elemento de agrupamento das respostas às solicitações de reprogramação de viagens do CPL ao sistema legado;
| ; |
Catalogo de mensagens
Âncora catmsg catmsg
| Código | Mensagem | Descrição |
Anexos
| Anexos |
|---|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas