Skip to main content
Skip table of contents

Como fazer a solicitação de cancelamento do TMS

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:

Clique aqui para expandir...
CODE
<Transmission>
	<TransmissionHeader>
		<Version>6.4.2</Version>
		<TransmissionCreateDt>
			<GLogDate>20220128071000</GLogDate>
			<TZId>UTC</TZId>
			<TZOffset>+00:00</TZOffset>
		</TransmissionCreateDt>
		<SenderTransmissionNo>186101</SenderTransmissionNo>
		<GLogXMLElementName>ShipmentStatus</GLogXMLElementName>
	</TransmissionHeader>
	<TransmissionBody>
		<GLogXMLElement>
			<ShipmentStatus xmlns:gtm="http://xmlns.oracle.com/apps/gtm/transmission/v6.4" xmlns:TMS="http://xmlns.oracle.com/apps/TMS/transmission/v6.4">
				<SendReason>
					<Remark>
						<RemarkSequence>1</RemarkSequence>
						<RemarkQualifierGid>
							<Gid>
								<Xid>QUERY TYPE</Xid>
							</Gid>
						</RemarkQualifierGid>
						<RemarkText>TRACKING EVENT</RemarkText>
					</Remark>
					<SendReasonGid>
						<Gid>
							<Xid>SEND INTEGRATION</Xid>
						</Gid>
					</SendReasonGid>
					<ObjectType>TRACKING EVENT</ObjectType>
				</SendReason>
				<StatusCodeGid>
					<Gid>
						<DomainName>EMBDEV</DomainName>
						<Xid>CANCELA</Xid>
					</Gid>
				</StatusCodeGid>
				<TimeZoneGid>
					<Gid>
						<Xid>UTC</Xid>
					</Gid>
				</TimeZoneGid>
				<EventDt>
					<GLogDate>20171114233000</GLogDate>
					<TZId>UTC</TZId>
					<TZOffset>+00:00</TZOffset>
				</EventDt>
				<StatusGroup>
					<StatusGroupGid>
						<Gid>
							<DomainName>EMBDEV</DomainName>
							<Xid>CLL_TMS_NDD_ENTREGA</Xid>
						</Gid>
					</StatusGroupGid>
					<StatusGroupDescription>CLL_TMS_NDD</StatusGroupDescription>
				</StatusGroup>
				<ResponsiblePartyGid>
					<Gid>
						<Xid>CARRIER</Xid>
					</Gid>
				</ResponsiblePartyGid>
				<ReportingUser>EMBDEV.ANALISTA1</ReportingUser>
				<EventRecdDate>
					<GLogDate>20171115013014</GLogDate>
					<TZId>UTC</TZId>
					<TZOffset>+00:00</TZOffset>
				</EventRecdDate>
				<FlexFieldStrings/>
				<FlexFieldNumbers/>
				<FlexFieldDates/>
				<ShipmentGid>
					<Gid>
						<DomainName>EMBDEV</DomainName>
						<Xid>8156</Xid>
					</Gid>
				</ShipmentGid>
			</ShipmentStatus>
		</GLogXMLElement>
	</TransmissionBody>
</Transmission>

É 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:

image-20240117-131448.png

O retorno do cancelamento, com o resultado do processamento será enviado pelo ao TMS na seguinte estrutura:

Clique aqui para expandir...
CODE
<Transmission>
    <TransmissionHeader xmlns="http://xmlns.oracle.com/apps/TMS/transmission/v6.4">
        <GLogXMLElementName>ActualShipment</GLogXMLElementName>
    </TransmissionHeader>
    <TransmissionBody xmlns="http://xmlns.oracle.com/apps/TMS/transmission/v6.4">
        <GLogXMLElement>
            <ActualShipment>
                <Shipment>
                    <ShipmentHeader>
                        <ShipmentGid>
                            <Gid>
                                <DomainName>EMBDEV</DomainName>
                                <Xid>SH-001</Xid>
                            </Gid>
                        </ShipmentGid>
                        <TransactionCode>IU</TransactionCode>
                        <InternalShipmentStatus>
                            <StatusTypeGid>
                                <Gid>
                                    <DomainName>EMBDEV</DomainName>
                                    <Xid>CANCELA_RETORNO</Xid>
                                </Gid>
                            </StatusTypeGid>
                            <StatusValueGid>
                                <Gid>
                                    <DomainName>EMBDEV</DomainName>
                                    <Xid>SUCESSO</Xid>
                                </Gid>
                            </StatusValueGid>
                        </InternalShipmentStatus>
                         <Remark>
                            <RemarkText>410|Cancelamento realizado com sucesso</RemarkText>
                        </Remark>
                    </ShipmentHeader>
                </Shipment>
            </ActualShipment>
        </GLogXMLElement>
    </TransmissionBody>
</Transmission>

É 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.

415

Cancelamento com falha relacionado a CIOT.

Páginas Relacionadas

{{component-feedback-article}}

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.