Histórico da Página
Introdução
| draw.io Diagram | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
Sistemas Envolvidos
TOTVS Otimização Logística / 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
TOL/TRE
Escopo
A interface
publishCancelService serve apenas para solicitar ao sistema externo permissão para
o cancelamento da carga no TOL\TRE.
- Para solicitar esta permissão, o
- TOL\TRE irá mandar uma mensagem ao sistema externo através da estrutura
- publishCancelService e o sistema externo deverá retornar uma mensagem de resposta ao
- TOL\TRE na estrutura
- publishCancelServiceResponse:
- Se o sistema externo retornar um status de que
- o cancelamento é possível (campo status=0), 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 TRE, o 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 TRE (que será feita através da interface publishReleasedTrip).
- Se o sistema externo retornar um status de que
- cancelamento não é possível (campo status=1 ou 2 ou 3 ou 4), 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 publishReprogrammingServiceRequestpublishCancelServicepublishReprogrammingServiceRequest publishCancelService
| publishReprogrammingServiceRequestpublishCancelService, Integração SOAP, Síncrona | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| regionSourceId | stringString | Sim | 30 | Identificador da regional; | Deve ser uma regional válida; |
| basketSourceId | stringString | Não | 30 | ID da cesta onde esta operação foi realizada manualmente pelo usuário no TRE; | Este campo poderá não ser enviado nos casos em que a solicitação de reprogramação foi feita o cancelamento foi feito de forma automática e não através da tela do TRE manualmente por um usuário através das telas (nestes casos, não se pode identificar a cesta do usuário); Os seguintes exemplos podem gerar mensagens de cancelamento automáticas para o sistema externo sem a informação da cesta do usuário: - Se um usuário que possui viagens não desbloqueadas é removido, nesta remoção suas viagens serão canceladas; - Uma doca associada a viagens não desbloqueadas é removida, nesta remoção suas viagens serão canceladas; - Um pedido é removido de forma automática (via integração) fazendo com que viagens não desbloqueadas fiquem sem DUs, forçando que estas sejam canceladas; |
| trips | trip[] | Sim | N/A | Elemento de agrupamento de todas as viagens do TRE que viagens que se quer reprogramar cancelamento ; | Deverá haver pelo menos 1 viagem do TRE nesta 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 | int | Sim | 10 | ID da viagem cuja reprogramação cujo cancelamento está sendo solicitada pelo TRE ao sistema legadosolicitado; | |
Âncora load load
| load, tipo de dado utilizado nas integrações do do TOL\TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| loadId | intInteger | Sim | 10 | Identificador de uma carga da viagem; | |
| loadSourceId | stringString | Não | 30 | Identificador externo de uma carga da viagem; | |
Layout de Resposta
Âncora publishReprogrammingServiceResponsepublishCancelServiceResponse publishReprogrammingServiceResponse publishCancelServiceResponse
| publishReprogrammingServiceResponsepublishCancelServiceResponse, tipo de dado utilizado nas integrações do 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 TRE que viagens que se quer reprogramar cancelamento com os respectivos status das solicitações; | Deverá haver pelo menos 1 viagem do TRE nesta nesta lista; |
| Âncora | ||||
|---|---|---|---|---|
|
| result, tipo de dado utilizado nas integrações do do TOL\TRE | |||||
|---|---|---|---|---|---|
| Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
| regionSourceId | stringString | Sim | 30 | Identificador da regional; | Deve ser uma regional válida; |
| tripId | intInteger | Sim | 10 | ID da viagem cuja reprogramação foi solicitada pelo CPL ao sistema legadocujo cancelamento foi solicitado; | |
| status | intInteger | Sim | 1 | Status da solicitação de reprogramação cancelamento de viagem enviada pelo CPL ao sistema legado; | 0= Reprogramação autorizadaViagem cancelada com sucesso; 1=Viagem já estava 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, o CPL irá efetuar o cancelamento da viagem automaticamente e o sistema externo não será novamente notificado deste cancelamento pelo CPL (como foi o sistema externo que informou que a viagem já está cancelada, esta notificação extra do CPL é desnecessária; - Se o sistema externo retornar os códigos 2 ou 3, não será possível reprogramar a viagem no CPL ; 4=Viagem não pode ser cancelada; O processo de cancelamento deverá funcionar da seguinte forma: - Ao solicitar o cancelamento da viagem (ou carga) , a interface de notificação de cancelamento de viagens (ou cargas) informará o sistema externo, se o sistema externo confirmar o cancelamento da viagem (ou carga) através dos status 0, 1 ou 2, esta também será cancelada no TOL/TRE; Importante: as delivery units das viagens canceladas serão sempre devolvidas para a cesta do respectivo usuário; |
Catalogo de mensagens
Âncora catmsg catmsg
| Código | Mensagem | Descrição |
Anexos
| Anexos |
|---|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas