Para receber o cancelamento do TMS é necessário que esta ocorrência esteja devidamente configurada em Configurações Gerais > Gerais > Ocorrências. O cancelamento deve ser enviado pelo TMS ao NDD Frete na seguinte estrutura:
É possível enviar o evento de cancelamento isolado através do ShimentStatus, ou dentro do embarque, respeitando a estrutura de ShipmentStatus.
Campos em destaque
/Transmission/TransmissionBody/GLogXMLElement/ActualShipment/ShipmentStatus/StatusCodeGid/Gid: Identificação do evento que está sendo gerado, neste caso cancelamento. O DomainName e Xid informados devem ser os mesmos configurados nas Configurações Gerais > Gerais > Ocorrências.
/Transmission/TransmissionBody/GLogXMLElement/ActualShipment/ShipmentStatus/ReportingUser: É obrigatório informar o usuário que executou a ação de cancelamento no TMS. Será utilizado na apresentação de histórico. O usuário informado aqui não precisa estar cadastrado no NDD Frete Embarcador, pois não é feita nenhuma validação sobre essa informação.
/Transmission/TransmissionBody/GLogXMLElement/ActualShipment/ShipmentStatus/ShipmentGid/Gid: Identificação do embarque que está sendo cancelado com DomainName e Xid.
Na ocorrência de cancelamento não deve ser informado o conjunto de TAGs: /PlannedShipment/Shipment/ShipmentStatus/SSStop, pois o cancelamento refere-se a todo o embarque e não a documento de uma stop específica.
Retorno de cancelamento
Para que o retorno do cancelamento seja enviado para o TMS, é necessário que esta integração esteja devidamente configurada em Configurações Gerais > Gerais > Integração TMS,com o campo Tipo sendo igual a “Evento” e o campo Evento igual a “Cancelamento”. Conforme o exemplo:
O retorno do cancelamento, com o resultado do processamento será enviado pelo ao TMS na seguinte estrutura:
É possível enviar o evento de cancelamento isolado através do ShimentStatus, ou dentro do embarque, respeitando a estrutura de ShipmentStatus.
Campos em destaque:
/Transmission/TransmissionBody/GLogXMLElement/ActualShipment/Shipment/ShipmentHeader/InternalShipmentStatus/StatusTypeGid/Gid: Identificação do XID referente ao campo que receberá o resultado do processamento de cancelamento com o valor SUCESSO ou FALHA. Esta identificação deve estar parametrizada em Configurações Gerais > Gerais > Integração TMS.
/Transmission/TransmissionBody/GLogXMLElement/ActualShipment/Shipment/ShipmentHeader/InternalShipmentStatus/StatusValueGid/Gid:Neste conjunto de tags será informado se o processo ocorreu com sucesso ou falha, através do campo Xid.
SUCESSO
FALHA
/Transmission/TransmissionBody/GLogXMLElement/ActualShipment/Shipment/ShipmentHeader/: Concatenação do código do processo com a mensagem de sucesso ou falha.
Formato: código|mensagem;
Exemplo 1: 410|Cancelamento realizado com sucesso;
Exemplo 2: 415|Cancelamento com falha relacionado a CIOT.
Código
Mensagem
410
Cancelamento realizado com sucesso
411
Ocorrência (DomainName.XidStatus) não configurada;
Não é possível cancelar um embarque de forma parcial, para concluir o cancelamento remova o número da stop (número da stop) informado.
412
Cancelamento com falha relacionado a Documentos do Transporte.
413
Cancelamento com falha relacionado a IOD ou POD.
414
Cancelamento com falha relacionado a Documentos em Pagamento.