TransVirtual Standard Scan Import (XML V1.0)

Scan Import

Supplying your Scan's in this format provides easy and detail format for integration. This can be accepted in FTP or Email. Advise your integration contact of your preferred method.

<Scans>

<ScanType>Depot In</ScanType>

<ScanLocation>Sydney</ScanLocation>

<ScannedBy>Michael</ScannedBy>

<ScanUserComment> 1 Carton</ScanUserComment>

<AgentName>Freds Deliveries</AgentName>

</ScanEvent>

</Scans>

Notes

XML Element	Manatory (Y/N)	Notes
<Scans>	Y	Defines the start of the Manifest of Scan's
<ScanEvent>	Y	Defines the start of the Scan event
<ConsignmentNumber>	N*	Defines the Consignment Number the Scan information is for
<UniqueID>	N*	Defines the UniqueID the Scan information is for
<ScanDateTime>	Y	The date and time of the delivery. Format should be UTC Time** dd/MM/yyyy HH:mm, if not please advise the integration specialist of your format.
<BarcodeValue>	Y	This is the value that was scanned off the Item.
<ScanType>	Y	One of the scan types below; At Location - An item scan at the location of the receiving party Damaged - An item scan that shows the item is damaged Depot In - An item scan showing that the item has arrived at a depot Floor - An item scan that shows what was left in the depot after of delivery vehicles have left Held Over - Freight that did not travel on Linehaul to its next destination (ie Vehicle Full) Linehaul Out - Movement of freight between depot's Misdirected - An item scan that shows freight has arrived a the wrong depot On Delivery - An item scan that shows the item is on board for delivery Picked Up - An item scan of the freight at the sender location Short - An item scan to show what has arrived knowing some items are missing
<ScanLocation>	N	The location of the scan
<ScanLocationShort>	N	The short name of the location of the scan
<ScannedBy>	N	The name of the user scanning the items
<ExportDate>	N	The date and time of the export. Format should be UTC Time** dd/MM/yyyy HH:mm, if not please advise the integration specialist of your format.
<ScanDestLocation>	N	The destination of a linehaul scan
<ScanDestLocationShort>	N	The short name of the destination of a linehaul scan
<ScanVehicleName>	N	The name of the vehicle a linehaul/on delivery scan as been performed against
<ScanVehicleRego>	N	The rego of the vehicle a linehaul/on delivery scan as been performed against
<ScanVehicleAka>	N	The other name of the vehicle a linehaul/on delivery scan as been performed against
<ScanTag>	N	A tag selected against a scan (ie Floor scan with a scan tag of "Card Left"). In TransVirtual its a way to provide a predetermined value that is reportable.
<ScanUserComment>	N	A comment typed by an operator while scanning, against the item
<AgentName>	N	The matching agent name
<AgentCode>	N	The matching agent code
<ScanEventWeightCheckLength>	N	When performing a CWC against an item, the length value in Meters
<ScanEventWeightCheckWidth>	N	When performing a CWC against an item, the width value in Meters
<ScanEventWeightCheckHeight>	N	When performing a CWC against an item, the height value in Meters
<ScanEventWeightCheckWeight>	N	When performing a CWC against an item, the weight value in Kilos

* There can be either the Consignment Number of the UniqueID for the Scan to be allocated. Generally this is ConsignmentNumber

** Providing the date and time in UTC allows us to seemlessly work across timezones.

Minimum requires is a Scan Type, Scans Date and Time and the Scan Value.

Further samples below

<Scans>

<ScanType>Depot In</ScanType>

<ScanLocation>Sydney</ScanLocation>

<ScannedBy>Michael</ScannedBy>

<ScanUserComment> 1 Carton</ScanUserComment>

<AgentName>Freds Deliveries</AgentName>

</ScanEvent>

<ScanType>Floor</ScanType>

<ScanLocation>Sydney</ScanLocation>

<ScannedBy>Michael</ScannedBy>

<ScanTag>Short</ScanTag>

<ScanUserComment>Awaiting 1 Carton</ScanUserComment>

<AgentName>Freds Deliveries</AgentName>

</ScanEvent>

<ScanType>Linehaul Out</ScanType>

<ScanLocation>Sydney</ScanLocation>

<ScannedBy>Michael</ScannedBy>

<ScanDestLocation>Melbourne</ScanDestLocation>

</ScanEvent>

</Scans>

Related Articles
Scan EDI Import
In TransVirtual there is the ability to setup Scan EDI (Electronic Data Interchange) Import rules that can import scan data relating to consignments. These imports can be setup to receive information via FTP, Email, etc. This article will run through ...
TransVirtual Standard XML Import V1.0
XML Import Sending XML consignment data to TransVirtual using the following format is the most efficient and cost effective option. <Consignments> <Consignment> <ConsignmentNumber>ABDEM90241Aasdasdas</ConsignmentNumber> ...
Proof of Delivery EDI Import
Proof of Delivery EDI Import In TransVirtual there is the ability to create EDI (Electronic Data Interchange) Import rules that allow you to upload PODs and attach them to a consignment. This process would typically be used where an outside system is ...
TransVirtual Standard Status Update Import (XML V1.0)
Status Update Import Supplying your Statuses in this format provides easy and detail format for integration. This can be accepted in FTP or Email. Advise your integration contact of your preferred method. <Statuses> <StatusEvent> ...
Consignment EDI Import
Consignment EDI Import In TransVirtual there is the ability to create EDI (Electronic Data Interchange) Import rules that allow you to create consignments without the need to use the consignment creation page in the TransVirtual Web Portal. This is ...

TransVirtual Standard Scan Import (XML V1.0)

TransVirtual Standard Scan Import (XML V1.0)

Scan Import

Notes

Related Articles

Scan EDI Import

TransVirtual Standard XML Import V1.0

Proof of Delivery EDI Import

TransVirtual Standard Status Update Import (XML V1.0)

Consignment EDI Import