TransVirtual Standard XML Import V1.0

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>
           <ConsignmentDate>25/05/2016</ConsignmentDate>
           <CustomerCode>123456</CustomerCode>
           <ServiceLevel>Next Day</ServiceLevel>
           <CustomerIdentifier>DogDayIn</CustomerIdentifier>
           <SenderName>Smith n Sons</SenderName>
           <SenderAddress>Unit 4</SenderAddress>
           <SenderAddress2>187 High St</SenderAddress2>
           <SenderSuburb>Newcastle</SenderSuburb>
           <SenderState>NSW</SenderState>
           <SenderPostcode>2300</SenderPostcode>
           <SenderContact>Bob Smith</SenderContact>
           <SenderPhone>02 9876 5432</SenderPhone>
           <SenderEmail>test@testsender.com</SenderEmail>
           <PickupRequired>Yes</PickupRequired>
           <PickupReadyTime>18/04/2020 09:15</PickupReadyTime>
           <PickupBookingNote>Dock3</PickupBookingNote>
           <PickupCloseTime>17:00</PickupCloseTime>
           <PickupSpecialInstructions>Tail Lift Required</PickupSpecialInstructions>
           <ReceiverName>Better Delivery Services</ReceiverName>
           <ReceiverAddress>line1</ReceiverAddress>
           <ReceiverAddress2>8564 Market Close</ReceiverAddress2>
           <ReceiverSuburb>Cottesloe</ReceiverSuburb>
           <ReceiverState>WA</ReceiverState>
           <ReceiverPostcode>6011</ReceiverPostcode>
           <ReceiverContact>Sharon</ReceiverContact>
           <ReceiverPhone>08 2345 6788</ReceiverPhone>
           <ReceiverEmail>test@testreceiver.com</ReceiverEmail>
           <DeliveryBookingTime>20/04/2020 11:15</DeliveryBookingTime>
           <DeliveryCloseTime>17:00</DeliveryCloseTime>
           <DeliveryBookingNote>Dock2</DeliveryBookingNote>
           <SpecialInstructions>Authority to Leave</SpecialInstructions>
           <SenderReference>SNS102359800</SenderReference>
           <ReceiverReference>Receiver Reference</ReceiverReference>
           <ReferenceOther>ReferenceOther</ReferenceOther>
           <ReferenceOther2>ReferenceOther2</ReferenceOther2>
           <ConnoteDangerousGoodsUnNumber>UN0006</ConnoteDangerousGoodsUnNumber>
           <ConnoteDangerousGoodsClass>1.1E</ConnoteDangerousGoodsClass>
           <ConnoteDangerousGoodsPackingGroup>II</ConnoteDangerousGoodsPackingGroup>
           <ConnoteDangerousGoodsPackingSubRisk></ConnoteDangerousGoodsPackingSubRisk>
           <Items>
                <Item>
                      <Reference>Item Ref</Reference>
                      <Quantity>1</Quantity>
                      <Description>Pallet</Description>
                      <ItemContents>Car Parts</ItemContents>
                      <Weight>289</Weight>
                      <Length>1.4000</Length>
                      <Width>1.4000</Width>
                      <Height>1.6000</Height>
                      <Cubic></Cubic>
                      <Barcode>(01)09212345000000012</Barcode>
                      <RowDangerousGoodsUnNumber>UN0006</RowDangerousGoodsUnNumber>
                      <RowDangerousGoodsClass>1.1E</RowDangerousGoodsClass>
                      <RowDangerousGoodsPackingGroup>II</RowDangerousGoodsPackingGroup>
                      <RowDangerousGoodsPackingSubRisk></RowDangerousGoodsPackingSubRisk>
                      <RowDangerousGoodsContainerType>Carton</RowDangerousGoodsContainerType>
                      <RowDangerousGoodsNumberOfContainer>3</RowDangerousGoodsNumberOfContainer>
                      <RowDangerousGoodsAggregateWeight>89</RowDangerousGoodsAggregateWeight>
                      <RowDangerousGoodsUnNumber2>UN0006</RowDangerousGoodsUnNumber2>
                      <RowDangerousGoodsClass2>1.1E</RowDangerousGoodsClass2>
                      <RowDangerousGoodsPackingGroup2>II</RowDangerousGoodsPackingGroup2>
                      <RowDangerousGoodsPackingSubRisk2></RowDangerousGoodsPackingSubRisk2>
                      <RowDangerousGoodsContainerType2>Carton</RowDangerousGoodsContainerType2>
                      <RowDangerousGoodsNumberOfContainer2>3</RowDangerousGoodsNumberOfContainer2>
                      <RowDangerousGoodsAggregateWeight2>89</RowDangerousGoodsAggregateWeight2>
                </Item>
                <Item>
                      <Reference>Item Ref</Reference>
                      <Quantity>2</Quantity>
                      <Description>Carton</Description>
                      <ItemContents>Car Parts</ItemContents>
                      <Weight>20</Weight>
                      <Length>0.3000</Length>
                      <Width>0.3000</Width>
                      <Height>0.3000</Height>
                      <Cubic>1.2</Cubic>
                      <Barcode>DEM90241002</Barcode>
                      <Barcode>DEM90241004</Barcode>
                      <RowDangerousGoodsUnNumber>UN0006</RowDangerousGoodsUnNumber>
                      <RowDangerousGoodsClass>1.1E</RowDangerousGoodsClass>
                      <RowDangerousGoodsPackingGroup>II</RowDangerousGoodsPackingGroup>
                      <RowDangerousGoodsPackingSubRisk></RowDangerousGoodsPackingSubRisk>
                      <RowDangerousGoodsContainerType>Carton</RowDangerousGoodsContainerType>
                      <RowDangerousGoodsNumberOfContainer>3</RowDangerousGoodsNumberOfContainer>
                      <RowDangerousGoodsAggregateWeight>89</RowDangerousGoodsAggregateWeight>
                      <RowDangerousGoodsUnNumber2>UN0006</RowDangerousGoodsUnNumber2>
                      <RowDangerousGoodsClass2>1.1E</RowDangerousGoodsClass2>
                      <RowDangerousGoodsPackingGroup2>II</RowDangerousGoodsPackingGroup2>
                      <RowDangerousGoodsPackingSubRisk2></RowDangerousGoodsPackingSubRisk2>
                      <RowDangerousGoodsContainerType2>Carton</RowDangerousGoodsContainerType2>
                      <RowDangerousGoodsNumberOfContainer2>3</RowDangerousGoodsNumberOfContainer2>
                      <RowDangerousGoodsAggregateWeight2>89</RowDangerousGoodsAggregateWeight2>
                </Item>
           </Items>
     </Consignment>
</Consignments>

Notes


 XML Element
 Mandatory (Y/N)
 Notes
<Consignments>
 Y
 Defines the start of the manifest of consignments
<Consignment>
 Y
 Defines the start of a consignment record
<ConsignmentNumber>
N
Defines the consignment number. Should be minimum 3 Prefix characters and 6 numbers - ABC123456.

You do not have to specify a consignment number, a consignment number will be automatically generated based on the customer card settings or global account settings.
<ConsignmentDate>
 N
Defines the consignment data. Format should be dd/MM/yyyy, if not please advise the integration specialist of your format.

If no date is provided, the date of the import is used
<CustomerCode>
N
If you have multiple accounts with a TransVirtual entity, you can define the customer code here to ensure it matches to the appropriate account
<ServiceLevel>
N
Defines the service level for the connote. Contact you business partner for the service levels appropriate to your account.
<CustomerIdentifier>
N
Used to define your customer when sending to a TransVirtual account of an agent, so that when talking to your customer service team, they can say "For <ConnoteNumber> for your customer <Customer Identifier>" to assist in communication. Can also be used in return data for identification purposes or just as a reference field/
<SenderName>
N (But Recommended)
Defines the Sender Name (Business Name). If not supplied will default to Customer Card or Customer Account settings
<SenderAddress>
N (But Recommended)
Defines the Sender Address (Line 1). If not supplied will default to Customer Card or Customer Account settings
<SenderAddress2>
N (But Recommended)
Defines the Sender Address (Line 2). If not supplied will default to Customer Card or Customer Account settings
<SenderSuburb>
N (But Recommended)
Defines the Sender Suburb. If not supplied will default to Customer Card or Customer Account settings
<SenderState>
N (But Recommended)
Defines the Sender State. If not supplied will default to Customer Card or Customer Account settings
<SenderPostcode>
N (But Recommended)
Defines the Sender Postcode. If not supplied will default to Customer Card or Customer Account settings
<SenderContact>
N
Defines the Sender Contact. 
<SenderPhone>
N
Defines the Sender Phone. 
<SenderEmail>
N
Defines the Sender Email. 
<PickupRequired>
N
Defines the if a pickup is required for this job. If this is defined as Yes, then the connote will be flagged as a pickup and presented on the pickup allocation controller for allocation to a driver. 
<PickupReadyTime>
N
Defines the Pickup Ready Time. Format should be dd/MM/yyyy HH:mm, if not please advise the integration specialist of your format. 
<PickupBookingNote>
N
Defines the Pickup Booking Notes
<PickupCloseTime>
N
Sending Location Close Time. Must be in the format HH:mm
<PickupSpecialInstructions>
N
Defines the Pickup Special Instructions
<SenderReference>
N
Defines the Sender Reference. For example - this could be an invoice, order or job number.
<ReceiverName>
N (But Recommended)
Defines the Receiver Name (Business Name). If not supplied will default to Customer Card or Customer Account settings
<ReceiverAddress>
N (But Recommended)
Defines the Receiver Address (Line 1). If not supplied will default to Customer Card or Customer Account settings
<ReceiverAddress2>
N (But Recommended)
Defines the Receiver Address (Line 2). If not supplied will default to Customer Card or Customer Account settings
<ReceiverSuburb>
N (But Recommended)
Defines the Suburb. If not supplied will default to Customer Card or Customer Account settings
<ReceiverState>
N (But Recommended)
Defines the State. If not supplied will default to Customer Card or Customer Account settings
<ReceiverPostcode>
N (But Recommended)
Defines the Postcode. If not supplied will default to Customer Card or Customer Account settings
<ReceiverContact>
N
Defines the Receiver Contact. 
<ReceiverPhone>
N
Defines the Receiver Phone. 
<ReceiverEmail>
N
Defines the Receiver Email. 
<DeliveryBookingTime>
N
Defines the Receiver Booking Time.  Format should be dd/MM/yyyy HH:mm, if not please advise the integration specialist of your format. 
<DeliveryCloseTime>
N
Receiving Location Close Time. Must be in the format HH:mm
<DeliveryBookingNote>
N
Defines the Booking Notes
<SpecialInstructions>
N
Defines the delivery special instructions
<ReceiverReference>
N
Defines the Receiver Reference. For example this could be an Order Number.
<ReferenceOther>
N
Another reference field
<ReferenceOther2>
N
Another reference field
<ConnoteDangerousGoodsUnNumber>
N
Defining a Dangerous Goods UN Number (At a consignment level) ie UN0006
<ConnoteDangerousGoodsClass>
N
Defining a Dangerous Goods Class (At a consignment level)
<ConnoteDangerousGoodsPackingGroup>
N
Defining a Dangerous Goods Packing Group (At a consignment level)
<ConnoteDangerousGoodsPackingSubRisk>
N
Defining a Dangerous Goods Sub Risk (At a consignment level)
<Items>
Y
Defines the start of the Item Rows
<Item>
Y
Defines the start of an Item Row
<Reference>
N
Defines an Item Row Reference Number
<Quantity>
Y
Defines the quanity of the items defined on the Item Row
<Description>
N (But Recommended)
This defines the item row description. If none is set it defaults to "Item"
<ItemContents>
N
This defines the content of the Description
<Weight>
N (But Recommended)
This defines the Item Row Total Weight in KG's. If this is not your Unit of measure please advise the integration specialist of your unit. 
<Length>
N (But Recommended)
This Defines the Item Row Length In Meters. If this is not your Unit of measure please advise the integration specialist of your unit. 
<Width>
N (But Recommended)
This Defines the Item Row Width In Meters. If this is not your Unit of measure please advise the integration specialist of your unit. 
<Height>
N (But Recommended)
This Defines the Item Row Height In Meters. If this is not your Unit of measure please advise the integration specialist of your unit. 
<Cubic>
N
This Defines the Item Row total Cubic. If the dims are supplied above, this will be created automatically
<Barcode>
N
This defines the Item Row barcodes. You can have multiple barcode elements or each barcode seperated by a space in on. TransVirtual supports standardised barcode formats by default (ie <ConnoteNumber><ItemNumber>). If your connote number exists with an item number in the barcode, we can map your format in, if it does not contain the connote number at all, you MUST supply the barcodes to enable scanning of your freight.
<RowDangerousGoodsUnNumber>
N
Defining a Dangerous Goods UN Number (At an Item Level)
<RowDangerousGoodsClass>
N
Defining a Dangerous Goods Class (At an Item Level)
<RowDangerousGoodsPackingGroup>
N
Defining a Dangerous Goods Packing Group  (At an Item Level)
<RowDangerousGoodsPackingSubRisk>
N
Defining a Dangerous Goods Sub Risk (At an Item Level)
<RowDangerousGoodsContainerType>
N
Defining a Dangerous Goods Container Type
<RowDangerousGoodsNumberOfContainer>
N
Defining a Dangerous Goods Container Quantity
<RowDangerousGoodsAggregateWeight>
N
Defining a Dangerous Goods Aggregate Weight
<RowDangerousGoodsUnNumber2>
N
Defining a second Dangerous Goods UN Number (At an Item Level)
<RowDangerousGoodsClass2>
N
Defining a second Dangerous Goods Class (At an Item Level)
<RowDangerousGoodsPackingGroup>
N
Defining a second Dangerous Goods Packing Group  (At an Item Level)
<RowDangerousGoodsPackingSubRisk>
N
Defining a second Dangerous Goods Sub Risk (At an Item Level)
<RowDangerousGoodsContainerType>
N
Defining a second Dangerous Goods Container Type
<RowDangerousGoodsNumberOfContainer>
N
Defining a second Dangerous Goods Container Quantity
<RowDangerousGoodsAggregateWeight>
N
Defining a second Dangerous Goods Aggregate Weight

  1. TransVirtual uses the Australia Post Suburb, State & Postcode list. All address details must conform to this format to be imported correctly.
  2. Units of Measure for Dims are in Meters. If you cannot supply that, we need to know what your unit of measure is. (CM, M, Ft, Yards)
  3. Units of Measure for Weight are in Kilograms. If you cannot supply that, we need to know what your unit of measure is. (KG, Tonne)
  4. Cubic will be calculated when dims are supplied.
  5. Date and Date Time fields MUST be uniform across the XML. If an alternative format is required please notify of this requirement. 
  6. Service Levels must be discussed with the relevant Transport Company for available service levels for your account(s).
  7. Item descriptions should be discussed with the relevant Transport Company. Item Contents can be used for finer detail of a freight item.
    • Related Articles

    • 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 ...
    • 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 POD Import (XML V1.0)

      POD Import Supplying your POD'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. <PODs> <PODEvent> ...
    • 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> <ScanEvent> ...
    • 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> ...