Histórico da Página
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
A interface PublishReprogrammingService serve apenas para solicitar ao sistema externo permissão para a reprogramação da carga no TRE.
- Para solicitar esta permissão, o TRE irá mandar uma mensagem ao sistema externo através da estrutura Cópia de Solicitação de reprogramação e o sistema externo deverá retornar uma mensagem de resposta ao TRE na estrutura Cópia de Solicitação de reprogramação:
- Se o sistema externo retornar um status de que a reprogramação é possível (campo status=0), o 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 reprogramação não é possível (campo status=1 ou 2 ou 3), o TRE não permitirá ao usuário a alteração da carga.
- Se o sistema externo retornar um status de que a reprogramação é possível (campo status=0), o TRE permitirá ao usuário a alteração da carga.
- Solicitação de cancelamento de viagens ao sistema externo
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
Âncora publishReprogrammingServiceRequestpublishCancelServicepublishReprogrammingServiceRequest publishCancelService
publishReprogrammingServiceRequestpublishCancelService, 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 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 manualmente por um usuário através das telas do TRE (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: - Um usuário que possui viagens não desbloqueadas é removido do TRE e a opção selecionada nesta remoção é de que estas viagens sejam canceladas; - Uma doca associada a viagens não desbloqueadas é removida do TRE e a opção selecionada nesta remoção é de que estas viagens sejam canceladas; - Um pedido é removido do TRE 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 se quer reprogramar; | Deverá haver pelo menos 1 viagem do TRE 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 TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
tripId | int | Sim | 10 | ID da viagem cuja reprogramação está sendo solicitada pelo TRE ao sistema legado; |
Âncora load load
load, tipo de dado utilizado nas integrações do TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
loadId | int | Sim | 10 | Identificador de uma carga da viagem; | |
loadSourceId | string | 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 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 se quer reprogramar com os respectivos status das solicitações; | Deverá haver pelo menos 1 viagem do TRE nesta lista; |
Âncora | ||||
---|---|---|---|---|
|
result, tipo de dado utilizado nas integrações do TRE | |||||
---|---|---|---|---|---|
Nome | Tipo | Obrigatório | Tamanho | Descrição | Observações |
regionSourceId | string | Sim | 30 | Identificador da regional; | Deve ser uma regional válida; |
tripId | int | Sim | 10 | ID da viagem cuja reprogramação foi solicitada pelo CPL TRE ao sistema legado; | |
status | int | Sim | 1 | Status da solicitação de reprogramação de viagem enviada pelo CPL TRE 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) no TRE , a interface de notificação de cancelamento de viagens (ou cargas) será executada pelo TRE com o sistema externo; se o sistema externo confirmar o cancelamento da viagem (ou carga) através dos status 0, 1 ou 2 acima, esta também será cancelada no 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 |
---|