Customer Import Via XML - Documentation

EDI Integration is an ideal solution for streamlining your operations and ensuring that we have your freight information as soon as it’s available. All that's required is that we are sent the information in a structured file format via FTP (File Transfer Protocol).

Consignment Manifest Structure

This is the file which contains the data to consignments being imported to Hi-Trans Express.

An example xml file, xml schema and field descriptions can be found below:

Manifest field description

XML Property	Description	Formatting/Restrictions

XML Property	Description	Formatting/Restrictions
consignmentNo	Consignment number. Must contain pre-approved consignment number prefix assigned by Hi-Trans	string Max length 18 characters
despatchDate	Date consignment is despatched	string dd/MM/yyy
serviceCode	Hi-Trans Express service level G=General, X=Express, L=Local, F=Full Load	string G,X,L,F
consignmentInstructions	Up to 120 character general instructions	string Max length 120 characters
senderName		string Max length 50 characters
senderAddress1		string Max length 50 characters
senderAddress2		string Max length 50 characters
senderAddress3		string Max length 50 characters
senderSuburb		string
senderState		string
senderPostcode		unsignedShort
senderInstructions	Up to 120 character instructions for pickup	string Max 120 characters
senderSiteContact	Contact name of person at sender site	string
senderSitePhone	Contact phone number of person at sender site	string
senderReference	Custom sender reference field	string Max 20 characters
pickupReadyDate	Date pickup is required in format dd/MM/yyyy Must be filled out if pickup creation is enabled via consignment import	string dd/MM/yyyy
pickupReadyTime	Time pickup is ready at in format HH:mm Must be filled out if pickup creation is enabled via consignment import	string HH:mm
pickupCloseTime	Time business closes for pickup in format HH:mm Must be filled out if pickup creation is enabled via consignment import	string HH:mm
receiverName		string Max length 50 characters
receiverAddress1		string Max length 50 characters
receiverAddress2		string Max length 50 characters
receiverAddress3		string Max length 50 characters
receiverSuburb		string
receiverState		string
receiverPostcode		unsignedShort
receiverInstructions	Up to 120 character instructions for delivery	string Max 120 characters
receiverSiteContact	Contact name of person at receiver site	string
receiverSitePhone	Contact phone number of person at receiver site	string
receiverReference	Custom receiver reference field	string Max 20 characters
deliveryRequiredDate	Required delivery date in format dd/MM/yyyy Used for timeslot deliveries	string dd/MM/yyyy
deliveryRequiredTime	Required delivery date in format HH:mm Used for timeslot deliveries	string HH:mm
totalChep	Total number of Chep pallets for transfer	integer 0 - 999
totalLoscam	Total number of Loscam pallets for transfer	integer 0 - 999
totalPlain	Total number of customer owned pallets	integer 0 - 999
totalSpaces	Total number of pallet Spaces for this consignment	integer 0 - 999
itemReference	Custom reference for order line	string Max 20 characters
logisticUnit	Logistic units name. Must match the rating/charge units if using a unit rate.	string
description	Friendly description of goods	string Max 20 characters
quantity	Total number of items for order line	integer 0 - 999
weight	Total weight in tonnes for order line.	decimal 0.000 - 999.999
length	Length of each unit on order line in metres	decimal 0.000 - 999.999
width	Width of each unit on order line in metres	decimal 0.000 - 999.999
depth	Depth of each unit on order line in metres	decimal 0.000 - 999.999
cube	Total Volume for order line in cubic metres	decimal 0.000 - 999.999
palletSpaces	Total pallet spaces for order line	integer 0 - 999
unCode	Dangerous Goods UN number for order line. For mixed dangerous goods use UN number 0000. Leave blank if no DG	unsignedShort
unAmount	UN amount in litres or kilograms. Leave blank if no DG	decimal 0.0 - 9999.9
sscc	Must contain a valid SSCC label for scanning excluding the application identifier 00. Cannot be used for custom barcodes	string
palletNumber	Optional pallet number for barcode	integer 0 - 999

File naming

The file can be transferred to us using FTP. The optimal method of file naming is to include the account Hi-Trans account number you are importing for followed by an underscore as a prefix, and then tacking on a reference or date after this prefix.

Eg. 9180_564513287.xml