Histórico da Página

Introdução

draw.io Diagram

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.

A interface publishCancelService serve apenas para solicitar ao sistema externo permissão para a cancelamento da carga no TRE.
- Para solicitar esta permissão, o TRE irá mandar uma mensagem ao sistema externo através da estrutura publishCancelService e o sistema externo deverá retornar uma mensagem de resposta ao TRE na estrutura publishCancelServiceResponse:
  - Se o sistema externo retornar um status de que o cancelamento é possível (campo status=0), o TRE permitirá ao usuário a alteração da carga.
  - Se o sistema externo retornar um status de que cancelamento não é possível (campo status=1 ou 2 ou 3 ou 4), o TRE não permitirá ao usuário a alteração da carga.

Âncora

	publishCancelService
	publishCancelService

publishCancelService, 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 o cancelamento foi feito de forma automática e não 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 cancelamento ;	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 cancelamento 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;

Âncora

	publishCancelServiceResponse
	publishCancelServiceResponse

publishCancelServiceResponse, 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 cancelamento com os respectivos status das solicitações;	Deverá haver pelo menos 1 viagem do TRE nesta lista;

Âncora

	result
	result

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 cancelamento foi solicitada pelo TRE ao sistema legado;
status	int	Sim	1	Status da solicitação de cancelamento de viagem enviada pelo TRE ao sistema legado;	0=Viagem cancelada com sucesso; 1=Viagem já estava cancelada; 2=Viagem não encontrada; 3=Viagem já despachada; 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;

Âncora

	catmsg
	catmsg

Código

Mensagem

Descrição

Anexos