ShipmentHeader

Shipment identification, status, attributes, costs, weight, carrier.

XML Path: /Transmission/TransmissionBody/GLogXMLElementType/PlannedShipment/Shipment/ShipmentHeader


<ShipmentHeader>
	<ShipmentGid>
		<Gid>
			<DomainName>COMPANY1</DomainName>
			<Xid>201216-0025</Xid>
		</Gid>
	</ShipmentGid>
	<ShipmentRefnum>
		<ShipmentRefnumQualifierGid>
			<Gid>
				<DomainName>COMPANY1</DomainName>
				<Xid>CLL_IMPOSTO_INCLUSO</Xid>
			</Gid>
		</ShipmentRefnumQualifierGid>
		<ShipmentRefnumValue>S</ShipmentRefnumValue>
	</ShipmentRefnum>
	<ShipmentRefnum>
		<ShipmentRefnumQualifierGid>
			<Gid>
				<DomainName>COMPANY1</DomainName>
				<Xid>CLL_IMPOSTO_SOMADO</Xid>
			</Gid>
		</ShipmentRefnumQualifierGid>
		<ShipmentRefnumValue>S</ShipmentRefnumValue>
	</ShipmentRefnum>
	<ShipmentRefnum>
		<ShipmentRefnumQualifierGid>
			<Gid>
				<DomainName>COMPANY1</DomainName>
				<Xid>CLL_PERCENTUAL_GRIS</Xid>
			</Gid>
		</ShipmentRefnumQualifierGid>
		<ShipmentRefnumValue>0.005</ShipmentRefnumValue>
	</ShipmentRefnum>
	<ShipmentRefnum>
		<ShipmentRefnumQualifierGid>
			<Gid>
				<DomainName>COMPANY1</DomainName>
				<Xid>CLL_PERCENTUAL_ADVALOREM</Xid>
			</Gid>
		</ShipmentRefnumQualifierGid>
		<ShipmentRefnumValue>0.004</ShipmentRefnumValue>
	</ShipmentRefnum>
	<ShipmentRefnum>
		<ShipmentRefnumQualifierGid>
			<Gid>
				<DomainName>COMPANY1</DomainName>
				<Xid>CLL_FINALIDADE_SAIDA</Xid>
			</Gid>
		</ShipmentRefnumQualifierGid>
		<ShipmentRefnumValue>1</ShipmentRefnumValue>
	</ShipmentRefnum>
	<InternalShipmentStatus>
		<StatusTypeGid>
			<Gid>
				<DomainName>COMPANY1</DomainName>
				<Xid>CLL_STATUS_VIAGEM</Xid>
			</Gid>
		</StatusTypeGid>
		<StatusValueGid>
			<Gid>
				<DomainName>COMPANY1</DomainName>
				<Xid>PLANEJADO</Xid>
			</Gid>
		</StatusValueGid>
	</InternalShipmentStatus>
	<InternalShipmentStatus>
		<StatusTypeGid>
			<Gid>
				<DomainName>COMPANY1</DomainName>
				<Xid>CLL_STATUS_EMISSAO</Xid>
			</Gid>
		</StatusTypeGid>
		<StatusValueGid>
			<Gid>
				<DomainName>COMPANY1</DomainName>
				<Xid>PRE_EMISSAO_ENVIADA</Xid>
			</Gid>
		</StatusValueGid>
	</InternalShipmentStatus>
	<ServiceProviderGid>
		<Gid>
			<DomainName>COMPANY1</DomainName>
			<Xid>614719</Xid>
		</Gid>
	</ServiceProviderGid>
	<TotalPlannedCost>
		<FinancialAmount>
			<GlobalCurrencyCode>BRL</GlobalCurrencyCode>
			<MonetaryAmount>19.39</MonetaryAmount>
		</FinancialAmount>
	</TotalPlannedCost>
	<TotalActualCost>
		<FinancialAmount>
			<GlobalCurrencyCode>BRL</GlobalCurrencyCode>
			<MonetaryAmount>19.39</MonetaryAmount>
		</FinancialAmount>
	</TotalActualCost>
	<ShipmentCost>
		<ShipmentCostSeqno>833501</ShipmentCostSeqno>
		<CostType>B</CostType>
		<Cost>
			<FinancialAmount>
				<GlobalCurrencyCode>BRL</GlobalCurrencyCode>
				<MonetaryAmount>17.83</MonetaryAmount>
			</FinancialAmount>
		</Cost>
	</ShipmentCost>
	<ShipmentCost>
		<ShipmentCostSeqno>833502</ShipmentCostSeqno>
		<CostType>A</CostType>
		<Cost>
			<FinancialAmount>
				<GlobalCurrencyCode>BRL</GlobalCurrencyCode>
				<MonetaryAmount>1.56</MonetaryAmount>
			</FinancialAmount>
		</Cost>
		<AccessorialCodeGid>
			<Gid>
				<DomainName>COMPANY1</DomainName>
				<Xid>COMPLEMENTO_DESCARGA</Xid>
			</Gid>
		</AccessorialCodeGid>
	</ShipmentCost>
	<TransportModeGid>
		<Gid>
			<Xid>LTL</Xid>
		</Gid>
	</TransportModeGid>
	<StartDt>
		<GLogDate>20201216001138</GLogDate>
		<TZId>America/Sao_Paulo</TZId>
		<TZOffset>-03:00</TZOffset>
	</StartDt>
</ShipmentHeader>

Field	Type	Occurrences	Max. Length	Format	Description
ShipmentGid	Character	1-1	49	-	Shipment identification with a unique key compounded by the domain and a number or a group of letters.
ShipmentRefnum		0-N			Custom fields for specific processes, such as tax calculation, toll calculation and CIOT issuing.
InternalShipmentStatus					Through the status informed here, NDD Frete knows which step of the logistic flow the shipment is, and if it is possible to update or not. It´s mandatory to inform in every request both status: trip status: CLL_STATUS_VIAGEM and issuing status: CLL_STATUS_EMISSAO, with the following content.
ServiceProviderGid					The carrier location reference.
TotalPlannedCost		0-1	-	Go to format	The total amount of money that is planned on this transport. The basis and accessories costs summed.
TotalActualCost		1-1	-	Go to format	The current total amount of money, including the extra costs added after the shipment has been planned.
TotalWeightedCost		0-1	-	Go to format	The total amount of operation costs that doesn't change the freight cost.
ShipmentCost		1-N			Costs details. All the individual costs must be informed here.
TransportModeGid					The kind of transport mode this shipment is. The transport mode informed here must be the same set in NDD Frete.
StartDt					The day and the hour that the operation will start. •Inbound: The start date is when the truck leaves the carrier's branch to pick-up the products; •Outbound: The start date is when the truck leaves the shipper's branch with all the products to be delivered.