Consignment XML Specificationsbalmoral.ifsconnect.net/...consignment_xml...v111.pdf · consignment...
Transcript of Consignment XML Specificationsbalmoral.ifsconnect.net/...consignment_xml...v111.pdf · consignment...
SmartFreight® Consignment XML Specifications
SmartFreight® Version 1.11 20/07/2017
Version
Version Date Revision/Description Author
1.0 19/11/2006 Initial Release M Toolan
1.1 09/02/2009 Dangerous Goods customisation M Toolan
1.2 17/06/2010 Pallet control customisation M Toolan
1.3 15/09/2011 Connote number import customisation M Toolan
1.4 15/11/2012 Export field customisation M Toolan
1.5 17/11/2012 Updated format M Toolan
1.6 23/04/2015 Updated format N Goundar
1.7 07/07/2016 Updated format N Goundar
1.8 23/08/2016 Updated format A Habib
1.9 05/05/2017 New Zealand - Address Fields update H Young
1.10 08/05/2017 Document Rebranded H Young
1.11 20/07/2017 International shipping updates A Habib
CONTENTS
1. OTHER SMARTFREIGHT® INTEGRATION DOCUMENTS .. 5
2. DEVELOPMENT PORTAL ................................................... 5
3. BEFORE YOU BEGIN .......................................................... 5
4. CONFIDENTIALITY ............................................................. 5
5. DOCUMENT OBJECTIVE .................................................... 6
5.1 Specific Document Objective 6
6. SMARTFREIGHT® SOLUTIONS ......................................... 6
7. XML CONSTRUCTION......................................................... 7
7.1 Case Sensitivity in XML 7
8. XML CONSTRUCTION SPECIFICS ..................................... 7
8.1 Data Types and acceptable string and numeric lengths 7
8.2 Acceptable Boolean Fields 7
8.3 Creating an XML Consignment 7
8.4 Multiple Consignments in one Document 8
8.5 Addresses Formats - General 9
8.6 For country specific examples, please see - Appendix A 9
8.7 Receiver Details 10
8.7.1 Optional Receiver Fields 10
8.8 Sender Details 11
8.8.1 Optional Sender Fields 12
8.9 Carrier Details 13
8.10
Freight Line Details 16
8.11
Special Instructions 20
8.12
Additional References 21
9. SMARTFREIGHT® EXPORT FORMAT .............................. 22
9.1 Rate Information 22
10. CONSIGNMENTS THAT CONTAIN VALIDATION ERRORS23
11. EXAMPLE XML EXPORT FILE .......................................... 24
12. 13.0 DEFINITIONS - COUNTRY SPECIFIC ........................ 26
APPENDIX A: COUNTRY SPECIFIC ADDRESS STRUCTURES27
Australian - Address Fields 27
Republic of Ireland -Address Fields 27
New Zealand - Address Fields 28
Proposed New Zealand - Address Fields update 28
South African - Address Fields 29
United Kingdom - Address Fields 29
APPENDIX B: FULL FIELD EXPLANATION ............................. 31
APPENDIX C: SERVICE OPTIONS ........................................... 44
APPENDIX D: LIST OF COUNTRIES (ISO 3166) ...................... 45
SmartFreight® - Consignment XML Specifications 5
1. Other SmartFreight® Integration Documents
Document Name Purpose Version
Number
Consignment XML
Specification
XML Construction 1.11
File Import XML File Import configuration 1.2
Advanced Web Services WS re additional functionality options 1.4
Business Process
Discovery
Q&A to assist construction of
integration
1.2
Calculate Best Rate WS re Best Rate for Shopping Cart 1.2
Cost Comparison WS re All Rates for Shopping Cart 1.2
Web Service Import WS re Import and creation of
consignment
1.2
2. Development Portal
SmartFreight® have developed on Online Portal to assist developers wishing to
integrate with SmartFreight® products. The Portal will provide access to all relevant
documents, which you can use to test your Consignment XML Parameter and view
the response from the Web Service.
If you have not been provided with a logon and password for this Portal, please
contact the SmartFreight® Support Team.
3. Before You Begin
Prior to commencing to construct any integration, we suggest that you engage
with the client’s logistics team to discuss their process to ensure end solution
meets their specific needs.
We have prepared a document in the form of a questionnaire (Business
Processes Discovery) to assist you with this process.
4. Confidentiality
All data contained in this document is regarded by the IFS Group as Confidential
Intellectual Property of the IFS Group of Companies. Any unauthorised use of the
confidential information contained in this document, other than for the agree purpose
of writing an integration to one of the SmartFreight® solutions; will be regarded as a
breach of confidentiality.
The IFS Group reserve the right to pursue all legal avenues available to it to remedy
the matter including but limited to liquidated damages or compensation for
consequential loss.
SmartFreight® - Consignment XML Specifications 6
5. Document Objective
To provide our clients and alliance partners with the ability to integrate to one or more
of the IFS Group suite of SmartFreight® solutions.
The IFS Group have a number of other integration documents that may be required to
be read, implemented in conjunction with this document. See Other SmartFreight®
Integration Documents for full list of all Integration Documents
5.1 Specific Document Objective
To provide specifications on the XML Schema used across all SmartFreight® products to facilitate both import and export of freight data.
6. SmartFreight® Solutions
The following SmartFreight® solutions can be integrated to using this document. Note: You may be required to use other Integration Documents to in conjunction with this document in order to integrate to a specific SmartFreight® solution. See Other SmartFreight® Integration Documents.
SmartFreight® Enterprise – Locally installed SQL database solution, multi-carrier Transport Management Software for high volume shippers.
SmartFreight® Express – Web-based, multi-carrier Transport Management
Software solution for low volume shippers or shippers with multi-branch networks.
SmartFreight® Drop Shipper – Allows you to direct ship (Drop Ship) goods from
supplier in any country directly to your customer’s doorstep.
SmartFreight® - Consignment XML Specifications 7
7. XML Construction
XML (Extensible Markup Language) is a flexible way to create common information
formats and share both the format and the data on the World Wide Web, intranets,
and elsewhere. XML has now become the almost universally supported way of
exchanging documents and data across applications and platforms.
XML provides SmartFreight® with the flexibility to change our format when the
requirements of a carrier may change. Changes in the XML document will not effect,
or break your existing applications because you only need to specify those fields
which are of a concern to you, applications changes are therefore minimal.
7.1 Case Sensitivity in XML
● SmartFreight® reads XML documents in a case-insensitive manner
● All export data produced by SmartFreight® will be with lowercase element
names, with the exception of the root element
8. XML Construction Specifics
8.1 Data Types and acceptable string and numeric lengths
Please refer to the Appendix B for details about expected data types and maximum
and minimum lengths for each field in the XML document.
8.2 Acceptable Boolean Fields
A Boolean (true/false) style field can accept any
number of inputs.
8.3 Creating an XML Consignment
A simple XML consignment typically consists for 4 or 5 sections; Receiver details
(who you’re sending the freight to), Sender details (who is the shipping the freight,
this is typically your organization), Carrier Details (which company is delivering the
freight), possibly 3rd Party information if 3rd Party is paying for freight shipment and
finally the Freight Details (weights, descriptions, number of items, etc.)
True False
Yes No
1 0
-1
Y N
True False
SmartFreight® - Consignment XML Specifications 8
8.4 Multiple Consignments in one Document
SmartFreight® supports the ability to send/receive multiple consignments in the
document if XML standard file transfer is used. In the case of Web Services, only one
consignment per call is permitted. The term ‘document’ is a reference to either an
XML file, or a web service call. Multiple consignments are repeated inside the root
node. The root node of the xml document describes the contents of the document.
The root for importing is <connotes>, the root node for an export from SmartFreight®
is: <SmartFreight®_Export_File>. Inside this root node multiple <connote>
nodes can exist. The connote node contains all of the information of an individual
consignment.
Example of Import File containing multiple consignments
<connotes>
<connote>
.
.
</connote>
<connote>
.
.
</connote>
</connotes>
Example of Export File containing multiple consignments
<SmartFreight®_Export_File>
<connote>
.
.
</connote>
<connote>
.
.
</connote>
</SmartFreight®_Export_File>
Please note: SmartFreight® will only import consignments with the correct root node.
This is to prevent infinite loops, or confusion between imports and exports.
SmartFreight® - Consignment XML Specifications 9
8.5 Addresses Formats - General
An address in the SmartFreight® XML schema consists of 6 address lines. The
address needs to be broken up so that specific components of the address
correspond to the correct line. Validation against country specific postcode files /
databases exists in SmartFreight® to prevent incorrect addresses from being
imported and subsequently being provided to a transport provider.
Addresses and the required breakup are specific to the destination country, and
hence the tags are named generically as add1 through to add6.
8.6 For country specific examples, please see - Appendix A
Each address section will start with a unique tag, to describe the address, this may
be; <sendaddr> for senders address
<recaddr> receivers address
<tpyaddr> for a third party address.
Example Receiver Address with missing second address line.
<recaddr>
<add1>410 Church Street</add1>
<add3>North Parramatta</add3>
<add4>NSW</add4>
<add5>2151</add5>
</recaddr>
Example Sender Address with populated second line.
<sendaddr>
<add1>Suite 2, Level 1</add1>
<add2>9 Blaxland Road</add2>
<add3>Rhodes</add3>
<add4>NSW</add4>
<add5>2138</add5>
</sendaddr>
SmartFreight® - Consignment XML Specifications 10
8.7 Receiver Details
The receiver details contain information about the company/person to whom you are
sending the goods. The following tags are necessary for the creation of any
consignments in SmartFreight®. Note: Depending upon country being shipped to not
all fields are mandatory (see Appendix A)
Receiver Fields:
XML Fields Description
recname The name of the company or person receiving the freight.
recaccno Your account number for the receiver, this provides an easy
way for you to associate this receiver with a customer or other
application
recaddr Marks the start of the receiver address
add1 First address line. See the ‘Appendix A section of this document.
add2 See the ‘Appendix A section of this document.
add3 See the ‘Appendix A section of this document.
add4 See the ‘Appendix A section of this document.
add5 See the ‘Appendix A section of this document.
add6 See the ‘Appendix A section of this document.
type See the ‘Appendix A section of this document.
/recaddr Marks the end of the receiver address
The more details will you can provide about the receiver of your goods ensures that
delivery is on time, and without difficulty. The next fields are optional, but will greatly
assist in the delivery process.
For example providing contact names, and phone numbers, may allow a driver to call
the receiver if the address is hard to find, or no one is available to take delivery of the
goods.
8.7.1 Optional Receiver Fields
XML Fields Description
reccontact A contact name for a person at the delivery site.
recph A phone number for the contact person.
recmobile A mobile number for the contact person
recemail The email address of the contact person. If the SmartFreight®
module ‘Receiver Email‘ has been purchased, an automated
SmartFreight® - Consignment XML Specifications 11
email can be sent to this address, to inform the receiver that
the goods have been dispatched with a link to tracking
website.
recfax The fax number of the receiver
adhocrec If this receiver is a ‘one-off’ and you do not wish the details to
be saved in the SmartFreight® database, set this field to ‘Y’.
Example showing receiver details:
<connotes >
<connote>
<recaccno>CUST0001</recaccno>
<recname>SOFT TOYS CORPORATION</recname>
<recaddr>
<add1>68 LYGON STREET</add1>
<add3>CARLTON NORTH</add3>
<add4>VIC</add4>
<add5>3054</add5>
</recaddr>
<reccontact>FRED NERKS</reccontact>
<recph>9999 8888</recph>
<recmobile>0417 123 456</recmobile>
<recemail>[email protected]</recemail>
.
.
.
</connote>
</connotes>
8.8 Sender Details
The sender is your organisations details, multiple senders are allowed in
SmartFreight®, this allows you to have multiple company names / divisions.
Sender details only need to be specified in an import file, if you have multiple senders
set up in SmartFreight®. If you only have one sender, then those details will be auto-
populated by SmartFreight® if the data is omitted from the XML document.
A sender can be selected by passing a sender name that exists within SmartFreight®.
When only the sender name is specified the remaining details of address and contact
information are populated by the data stored within SmartFreight®.
If the sender details have been omitted, and multiple senders have been setup in
SmartFreight®, then a ‘default sender’ can be configured in SmartFreight® which will
auto-populate these details but this is not recommended due to obvious potential
mistakes with the chosen Sender being made arbitrarily.
SmartFreight® - Consignment XML Specifications 12
Senders can be dynamically added to the SmartFreight® database at time of import if
necessary by arranging with SmartFreight® implementation team to set Business
Rule within SmartFreight® such.
Sender Fields:
XML Fields Description
Sendname The name of the company or person sending the freight.
8.8.1 Optional Sender Fields
XML Fields Description
Sendaddr Marks the start of the senders address
add1 First address line. See the Appendix A section of this document.
add2 See the Appendix A section of this document.
add3 See the Appendix A section of this document.
add4 See the Appendix A section of this document.
add5 See the Appendix A section of this document.
add6 See the Appendix A section of this document.
type See the Appendix A section of this document.
/sendaddr Marks the end of the senders address
sendcontact Main freight contact person within you company.
sendph A phone number for the contact person, this can be a mobile
phone number.
sendemail Main freight contact persons email
sendfax The fax number of the sender
adhocsend If this sender is a ‘one-off’ and you do not wish the details to
be saved in the SmartFreight® database, a ‘Y’ can be
assigned to this field.
Example showing Sender Details
<connotes>
<connote>
<sendname>GREAT BEACH EQUIPMENT INC</sendname>
<sendaddr>
<add1>WAREHOUSE 3A</add1>
SmartFreight® - Consignment XML Specifications 13
<add2>34 SCARBOROUGH BEACH RD</add2>
<add3>SCARBOROUGH</add3>
<add4>WA</add4>
<add5>6019</add5>
</sendaddr>
<sendph>0417 567 890</sendph>
.
.
.
</connote>
</connotes>
8.9 Carrier Details
The carrier is the freight carrier or transport provider that is responsible for shipping
the freight. SmartFreight® will provide you, with a detailed list of valid information to
be utilised for each freight carrier in your specific country used by your client.
It is crucial that the correct syntax and relationships is used to eliminate as many
errors as possible for operators to correct. Many freight carriers have very specific
requirements in relation to what information they can accept. It is recommended that
the full list of freight Carriers, Services and Descriptions be built into three tables
within the ERP / WMS / Shopping Cart system to allow these to be easily activated in
future should your customer change freight carriers and eliminate costly re-coding in
the future.
The database of freight carrier names / valid services / valid packing descriptions will
be distributed to all users by SmartFreight® as required in order that any changes can
be incorporated into your ERP / WMS / Shopping Cart systems. Therefore the tables
built in the ERP / WMS / Shopping Cart systems should be able to be updated
remotely as required from time to time.
Mandatory Carrier Fields:
XML Fields Description
carriername The name of the freight carrier.
service The name of the service/product that the freight is to be shipped
under. Eg Express, Overnight, General. Please refer to the excel
spreadsheet for the correct list.
accno The account number that the freight company has provided to
your organization. This is so that the freight company can uniquely
identify and bill your company. This account is NOT provided by
SmartFreight®. It has been assigned to your clients organization
by the freight company. Note a company may be issued with more
than one account number by a freight carrier and there is a
SmartFreight® - Consignment XML Specifications 14
mandatory field. If only one account number present it can be left
out of data and SmartFreight® will auto-populate
OR
If the Least Cost Routing module has been purchased, SmartFreight® is capable of
determining the most cost efficient combination of carrier / service and auto-populate
the consignment with the most appropriate and cost-effective combination.
XML Fields Description
applyleastcost Specify ‘Yes’ if you want SmartFreight® to determine the carrier for
you.
OR
If the Least Cost Routing module has been purchased with Transit Time logic,
SmartFreight® is capable of determining the most cost efficient combination of carrier
/ service but only from options that will meet clients specified required transit time and
auto-populate the consignment with the most appropriate and cost-effective
combination.
XML Fields Description
Applyleastcostwithdeliver Specify ‘Yes’ if you want SmartFreight® to determine
the carrier for you within a specific delivery window.
Deliveryleadtime Specify delivery lead time. Can be in hours i.e. 24H =
24 Hours or 2D = 2 Days etc. Refer to Appendix B for
full details
OR
If your SmartFreight® receiver database has been setup to contain default carrier,
service, and account information for individual receivers; you may tap into this
information by using the following.
XML Fields Description
usereceiverdefaults Specify ‘Yes’ if you want SmartFreight® to use the carrier
information assigned to the receiver in the SmartFreight®
database.
SmartFreight® - Consignment XML Specifications 15
Various other options exist such as Fastest Delivery option, Apply Least Cost limited
to a specific carrier etc. Please refer to Appendix B for full details or contact the
SmartFreight® Integration Support Team to discuss in more detail.
Example showing carrier details
<connotes>
<connote>
.
.
<carriername>TNT</carriername>
<service>EXPRESS</service>
<accno>AVS1234</accno> .
.
.
</connote>
</connotes>
Example using Least cost routing
<connotes>
<connote>
.
.
<applyleastcost>Yes</applyleastcost>
.
</connote>
</connotes>
Example using Receiver Default Information
<connotes>
<connote>
.
<usereceiverdefaults>Yes</usereceiverdefaults>
.
</connote>
</connotes>
Example using specific Delivery Window
<connotes>
<connote>
.
<applyleastcostwithdeliver>Yes</ applyleastcostwithdeliver>
<deliveryleadtime>24H</ deliveryleadtime>
.
</connote>
</connotes>
SmartFreight® - Consignment XML Specifications 16
8.10 Freight Line Details
The freight lines in the consignment contain the information about the goods being
shipped.
The freight line section can be repeated in one consignment up to a maximum of five
(5) times. Each instance of a freight details section must start and end with the
<freightlinedetails> tag.
Individual carrier requirements dictate whether each field is mandatory. Typically, the
number of items and weight are required by all carriers but occasionally cubic volume
is regarded by some carriers as mandatory.
XML Fields Description
freightlinedetails Marks the start of the freight line details
ref Your reference for this line of freight, this is optional and
may be your invoice number, order number, etc
This field is what the two system that are being integrated
normally use as the Primary Key in order that data
exported by SmartFreight® back to your system uses this
field to identify data and write it back to the relevant ‘Order’
within the ERP/WMS/Shopping Cart
If you need to specify more than 5 references; See the
‘Additional references’ section of this document.
desc This is the description of the freight as recognised by a
freight company. Please refer to the carrier spreadsheet
for valid descriptions. Examples of descriptions would
include CARTON, SATCHEL, PALLET, DRUM etc
amt The number of physical parcels, pallets, etc. Which are
being shipped
countrymanufacture This is the products country of manufacture. Please refer
to the international shipping requirements for the country
of origin for more information (Refer to Appendix D for list
of Countries)
goods Description of the goods
pieces The number of inner items
val The total value of goods for this line of freight.
wgt The total weight for this freight line. Please note, this is
not the individual weight for each item, but the total for all
parcels, pallets, etc. associated with this line. This
measurement should be in KG.
Note: Unit or Measure and conversion logic exists for
countries where Imperial measurements used. Please
SmartFreight® - Consignment XML Specifications 17
discuss with your local SmartFreight® Integration
Manager for further details
cube The total volume for this freight line. This measurement
should be in m3
Note: Unit or Measure and conversion logic exists for
countries where Imperial measurements used. Please
discuss with your local SmartFreight® Integration
Manager for further details
len Optional. If <MultiplyLWH>Y</MultiplyLWH> Then the
length of one (1) item in cms, otherwise the total length for
this line.
Note: Unit or Measure and conversion logic exists for
countries where Imperial measurements used. Please
discuss with your local SmartFreight® Integration
Manager for further details
wdt Optional. If <MultiplyLWH>Y</MultiplyLWH> Then the
width of one (1) item in cms, otherwise the total width for
this line.
Note: Unit or Measure and conversion logic exists for
countries where Imperial measurements used. Please
discuss with your local SmartFreight® Integration
Manager for further details
hgt Optional. If <MultiplyLWH>Y</MultiplyLWH> Then the
height of one (1) item in cms, otherwise the total height for
this line.
Note: Unit or Measure and conversion logic exists for
countries where Imperial measurements used. Please
discuss with your local SmartFreight® Integration
Manager for further details
/freightlinedetails Marks the end of the freight line details
SmartFreight® - Consignment XML Specifications 18
Example showing one freight line
<connotes>
<connote>
.
.
<freightlinedetails>
<ref>MY REF 1111</ref>
<desc>CARTON</desc>
<amt>1</amt>
<wgt>12.45</wgt>
<cube>0.045</cube>
</freightlinedetails>
.
</connote>
</connotes>
Example showing multiple freight lines
<connotes>
<connote>
.
.
<freightlinedetails>
<ref>MY REF 1111</ref>
<desc>CARTON</desc>
<amt>6</amt>
<wgt>52.45</wgt>
</freightlinedetails>
<freightlinedetails>
<desc>PALLET</desc>
<amt>1</amt>
<wgt>112</wgt>
</freightlinedetails>
<freightlinedetails>
<desc>PALLET</desc>
<amt>1</amt>
<wgt>94</wgt>
</freightlinedetails>
.
.
</connote>
</connotes>
SmartFreight® - Consignment XML Specifications 19
Example showing Length, Width, Height
<connotes>
<connote>
.
.
<freightlinedetails>
<ref>MY REF 1111</ref>
<desc>CARTON</desc>
<amt>1</amt>
<wgt>12.45</wgt>
<len>20</len>
<wdt>27</wdt>
<hgt>42</hgt>
</freightlinedetails>
</connote>
</connotes>
Example showing one freight line, but multiple lines of reference.
<connotes>
<connote>
.
.
<freightlinedetails>
<ref>MY REF 1111</ref>
<desc>CARTON</desc>
<amt>6</amt>
<wgt>52.45</wgt>
</freightlinedetails>
<freightlinedetails>
<ref>INV #: 12345</ref>
</freightlinedetails>
<freightlinedetails>
<ref>ORD #: 98765</ref>
</freightlinedetails> .
.
</connote>
</connotes>
Note: If you require more than 5 lines of reference, please consider using the
‘Additional references’ section. Please note that only five (5) references can be
printed on labels and consignment notes.
SmartFreight® - Consignment XML Specifications 20
8.11 Special Instructions
The Special Instructions fields allow you to add, other delivery instructions to the
consignment. These additional instructions are printed on the freight label,
consignment notes, and transmitted electronically to the carrier. Examples of Special
instructions include phases such as “Deliver to rear entrance”, “Phone before
delivery”, “Attention: John Smith”, and “Deliver before 5pm”.
Some carriers will ‘Book’ specific time slots with Major Retailers for delivery to their
DC’s, these ‘Not Before XX/XX/XX’ and ‘Not After XX/XX/XX’ instructions should be
inserted here and SmartFreight® will map to relevant field for specific carrier.
There are three (3) available lines of special instructions each of 30 characters.
XML Fields Description
spins Marks the beginning of the Special Instructions
Sp1 First line of special instructions
Sp2 Second line of special instructions
Sp3 Third line of special instructions
/spins Marks the end of the Special instructions
Example of only one line of Special Instructions
<connotes>
<connote>
.
.
<spins>
<sp1>ATTENTION: JOHN SMITH</sp1>
</spins>
.
.
</connote>
</connotes>
Example of three lines of Special Instructions
<connotes>
<connote>
.
.
<spins>
<sp1>ATTENTION: JOHN SMITH</sp1>
<sp2>DELIVER TO REAR OF BUILDING</sp2>
<sp3>KNOCK THREE TIMES FIRST</sp3>
</spins>
.
SmartFreight® - Consignment XML Specifications 21
</connote>
</connotes>
8.12 Additional References
If you have the need to specify more than five lines of reference fields, the Additional
References section may be used. Additional References may contain an infinite
number of references, each 25 characters in length.
Example of multiple Additional References
<connotes>
<connote>
.
.
<additionalreferences>
<referenceno>1Y0000001444</referenceno>
<referenceno>1Y0000001445</referenceno>
<referenceno>1Y0000001446</referenceno>
<referenceno>1Y0000001447</referenceno>
<referenceno>1Y0000001448</referenceno>
<referenceno>1Y0000001449</referenceno>
<referenceno>1Y0000001450</referenceno>
<referenceno>1Y0000001451</referenceno>
<referenceno>1Y0000001452</referenceno>
<referenceno>1Y0000001453</referenceno>
</additionalreferences>
.
.
</connote>
</connotes>
SmartFreight® - Consignment XML Specifications 22
9. SmartFreight® Export Format
The format of the XML Export format which is produced from SmartFreight®, is the
same as the Import Format but includes addition al tags added during the
SmartFreight® shipping process. Please refer to Appendix B for full details
The Root Tag or Node name is different. All export documents have a root tag
<SmartFreight®_Export_File>
9.1 Rate Information
If your organization is getting information back from SmartFreight® via the Export
Module (this module needs to be purchased and activated), or via Web Services, the
same XML schema is returned. Additional fields will be populated, the most important
of these will relate to the chosen carrier / service if not dictated, consignment note
number, label barcode (some carriers track by individual carton barcode rather than
overall consignment number), freight cost, levies, surcharges, insurance fees etc.
These are broken down in the export file as follows:
XML Fields Description
rate Export Only. The freight charge ex tax.
totdgcharge Export Only. Dangerous goods charge ex tax.
surccharge Export Only. Any surcharges (eg. Saturday delivery) ex tax
totlevy Export Only. The charge for all and any levies (eg. Security, Fuel) ex
tax
inspremium Can be imported if appropriate. Insurance Premium paid ex tax
totsurchrg Export Only. Total Surcharges. = SurcCharge+totLevy+InsPremium
totalcost Export Only. Total Cost of Freight ex tax.
=rate+TotSurChrg+totdgcharge
gstamount Export Only. Tax added to TotalCost
grandtotrate Export Only. Total Cost including Tax
SmartFreight® is also capable of automatically adding Markup to the cost of freight.
This will allow you to appropriately invoice your customer for the freight charge plus a
margin if appropriate.
SmartFreight® - Consignment XML Specifications 23
If both the Markup and Export Modules are purchased, the following fields are
returned.
XML Fields Description
mrkupchrg Export Only. The amount of markup applied, as a currency
value
totcostplusmrkup Export Only. The markup applied plus the total freight cost ex
tax =TotalCost+ MrkupChrg
gstonmrkup Export Only. Tax payable on the totcostplusmrkup field.
grandtotmrkup Export Only. The total of the freight plus any markup, plus tax.
10. Consignments that contain Validation Errors
An attribute on the connote elements will be present if the consignment contains
errors and none otherwise. This HasErrors attribute if present will have a value of
“True”.
Examples of errors:
<connote HasErrors=”True”>
<recname error=”Receiver Name cannot be left blank”></recname>
<reccontact>FRED</recconnote>
. . .
</connote>
SmartFreight® - Consignment XML Specifications 24
11. Example XML Export File
<Connote Entity="1ZT">
<_currency>$</_currency>
<accno>98765423</accno>
<allocatedconid>D8557C77-19CA-4B18-8E43-7C615C6E4D82</allocatedconid>
<buttonsstate>10000000000</buttonsstate>
<carrierid>17</carrierid>
<carriername>AUSTRALIA POST</carriername>
<carrzone>W3</carrzone>
<chargeto>Sender</chargeto>
<chgwgt>0.46</chgwgt>
<com3>INV: 2187615</com3>
<com4>PICK: F2032325A</com4>
<com5>ORD: ABC1245</com5>
<condate>31/08/2016</condate>
<conno>45U2466431</conno>
<connotenumber>45U2466431</connotenumber>
<conprfx>45U</conprfx>
<consignmentdatenumber>20160831</consignmentdatenumber>
<creatorid>IMPORTED</creatorid>
<currency>AUD</currency>
<dailyid>1128902</dailyid>
<dailyid_wan>UN71128902</dailyid_wan>
<datelong>20160831</datelong>
<entityid>1ZT</entityid>
<freightlinedetails>
<amt>1</amt>
<cube>0.00774</cube>
<desc>1KG</desc>
<hgt>11</hgt>
<len>22</len>
<ref>SENDER REF:F2032325A</ref>
<wdt>32</wdt>
<wgt>0.46</wgt>
</freightlinedetails>
<fromzone>N1</fromzone>
<fromzoneother>EP STD SIGN</fromzoneother>
<grandtotmrkup>6.81</grandtotmrkup>
<grandtotrate>6.81</grandtotrate>
<gstamount>0.62</gstamount>
<gstonmrkup>0.62</gstonmrkup>
<identification>
<conid>D8557C77-19CA-4B18-8E43-7C615C6E4D82</conid>
</identification>
<importfilename>1921479</importfilename>
<labels>
SmartFreight® - Consignment XML Specifications 25
<labelno_tracking>45U2466431010226</labelno_tracking>
<nooflabelsdefault>1</nooflabelsdefault>
</labels>
<levys>
<amt>0.8</amt>
<chrg>0.04909091</chrg>
<desc>Fuel Levy</desc>
</levys>
<manifestnum>002100</manifestnum>
<manifestnumber>002100</manifestnumber>
<mrkupchrg>0.00</mrkupchrg>
<recaccno>2032325</recaccno>
<recaddr>
<add1>PO BOX 2</add1>
<add3>BROOME</add3>
<add4>WA</add4>
<add5>6725</add5>
<add6>AUSTRALIA</add6>
</recaddr>
<recontact>GARY SEVEN</recontact>
<recemail>[email protected]</recemail>
<recname>SEVEN AND SONS PTY LTD</recname>
<recph>0499898989</recph>
<recmobile>0499898987</recmobile>
<sendaddr>
<add1>SUITE 2 LEVEL 1</add1>
<add2>9 BLAXLAND ROAD</add2>
<add3>RHODES</add3>
<add4>NSW</add4>
<add5>2138</add5>
<add6>AUSTRALIA</add6>
</sendaddr>
<sendname>INTERACTIVE FREIGHT SYSTEMS</sendname>
<sendph>1300132151</sendph>
<service>EP STD SIGN</service>
<servicecode>S5</servicecode>
<spins>
<sp1>ATTN: GARRY SEVEN</sp1>
<sp2>RTS? CALL 1300999888</sp2>
<sp3>ITEMS: 1 X ABC1243</sp3>
</spins>
<taxrate>10</taxrate>
<totalcost>6.19</totalcost>
<totcostplusmrkup>6.19</totcostplusmrkup>
<totcube>0.00774</totcube>
<totdgcharge>0.00</totdgcharge>
<totitems>1</totitems>
<totlevy>0.04909091</totlevy>
SmartFreight® - Consignment XML Specifications 26
<totsurchrg>0.05</totsurchrg>
<totwgt>0.46</totwgt>
<zoneother>EP STD SIGN</zoneother>
</Connote>
12. 13.0 Definitions - Country Specific
● Article Number means unique barcode on label associated individual item of
freight
● BOL means Bill of Lading being transaction and or document that
encompasses entire individual shipment for international sea shipment
● Consignment Note means transaction and or document that encompasses
entire shipment for domestic air, road or rail shipment
o Australia, New Zealand
● CN22 Label means international custom compliant label for international air or
sea shipments if value of goods exceed tax or duty free threshold in country of
destination
● GST means Goods & Services Tax
o Australia, New Zealand
● HAWB means House Airway Bill being transaction and or document that
encompasses entire individual shipment for international air shipment
● INCOTERMS means internationally recognised standard terms of trade for
international shipments which dictates how movement of goods will be paid
commercial between shipper and receiver of shipment
● MAWB means Master Airway Bill being transaction and or document that
includes multiple HAWB’s in international air shipment
● MBOL means Master Bill of Lading being transaction and or document that
includes multiple BOL’s in international sea shipment
● SAC means Self Assessed Clearance process in certain countries where
value of goods does not exceed tax or duty free threshold in country of
destination
o Australia
● Shipper Letter of Instructions means document specifying specifics of type
of shipment including INCOTERMS, mode to transport (Sea or Air), Value of
Goods, country of origin etc for customs declarable international shipment
● VAT means Valued Added Tax
o Sth Africa, Ireland, United Kingdom
● Waybill means transaction and or document that encompasses entire
shipment for domestic air, road or rail shipment
o Sth Africa
SmartFreight® - Consignment XML Specifications 27
Appendix A: Country Specific Address Structures
Australian - Address Fields
XML Field Description
add1 First line of the address typically includes suite number, and level, or
street number and street name. Add1 is a mandatory field for all
addresses.
add2 This field is not mandatory, but can be used if the first line of
address needs two lines
add3 Mandatory, must contain the Suburb
add4 Mandatory, must contain the State
add5 Mandatory, must contain the Postcode
add6 Only required for international freight, contains the country name.
Will automatically default to Australia if not specified.
Republic of Ireland -Address Fields
XML Field Description
add1 First line of the address typically includes suite number, and level, or
street number and street name. Add1 is a mandatory field for all
addresses.
add2 This field is not mandatory, but can be used if the first line of
address needs two lines
add3 Mandatory, must contain the Town
add4 Mandatory, must contain the County
add5 Not required
add6 Only required for international freight, contains the country name.
Will automatically default to Ireland if not specified.
SmartFreight® - Consignment XML Specifications 28
New Zealand - Address Fields
XML Field Description
add1 First line of the address typically includes suite number, and level, or
street number and street name. Add1 is a mandatory field for all
addresses.
add2 This field is not mandatory, but can be used if the first line of
address needs two lines
add3 Mandatory, must contain the Town/Suburb
add4 The locality of the Town/Suburb, required if two Towns of the Same
name exist in same island.
add5 The Island of the address, either NI (for the north island) or SI
(for the south island)
add6 Only required for international freight, contains the country name.
Will automatically default to New Zealand if not specified.
Important note for New Zealand Addresses:
Note (1): Whilst the town is the only significant addressing field, should
SmartFreight® detect a conflict, e.g. two towns of the same name exist; then the
import will be placed in the SmartFreight® Import Errors screen until a user can lock
in the programs accepted locality, and island information. Otherwise you may specify
these in your XML structure.
Note (2): Only 243 ‘duplicate suburbs / towns’ exists at time of this document being
written and most and very remote hence chances of this issue occurring remote.
Proposed New Zealand - Address Fields update
XML Field Description
add1 First line of the address typically includes suite number, and level, or
street number and street name. Add1 is a mandatory field for all
addresses.
add2 This field is not mandatory, but can be used if the first line of
address needs two lines.
add3 Mandatory, must contain the Town/Suburb.
add4 Mandatory, the Location of the Town/Suburb.
add5 Mandatory, Postcode.
SmartFreight® - Consignment XML Specifications 29
add6 Only required for international freight, contains the country name.
Will automatically default to New Zealand if not specified.
Important note for New Zealand Addresses:
Note (1): Rural addresses are currently not available in the New Zealand Postcode
list update but this is subject to change. The RD number will be populated in add3 if
included.
South African - Address Fields
XML Field Description
add1 First line of the address typically includes suite number, and level, or
street number and street name. Add1 is a mandatory field for all
addresses.
add2 This field is not mandatory, but can be used if the first line of
address needs two lines
add3 Mandatory, must contain the Suburb/Town
add4 Mandatory, must contain the City
add5 Mandatory, must contain the Postcode
add6 Only required for international freight, contains the country name.
Will automatically default to South Africa if not specified.
United Kingdom - Address Fields
XML Field Description
add1 First line of the address typically includes suite number, and level, or
street number and street name. Add1 is a mandatory field for all
addresses.
add2 This field is not mandatory, but can be used if the first line of
address needs two lines
add3 Mandatory, must contain the Town
add4 County, this field is not mandatory
add5 Mandatory, must contain the Postcode as per the Royal Mail
add6 Only required for international freight, contains the country name.
Will automatically default to United Kingdom if not specified.
SmartFreight® - Consignment XML Specifications 30
This page deliberately left blank
SmartFreight® - Consignment XML Specifications 31
Appendix B: Full Field Explanation
Element Name Data Type Mandatory (M)
Conditional (C)
Optional (O)
Start (S)
End (E)
Description
<connote> N/A M Mark beginning of a connote
<condate> String[10] O Consignment date format dd/mm/yyyy
<conprfx> String [50] O The prefix of the connote for e.g.
<conprfx>GFL</conprfx>.
NOTE: when importing connote numbers into
SmartFreight® you need to check if your carrier
allow connote edit
<conno> String [50] O The numeric part of the connote number for e.g.
<conno>371275</conno>
NOTE: when importing connote numbers into
SmartFreight® you need to check if the carrier
allow connote edit
<recaccno> String[30] M Receiver Account Number or Debtor Code. Each
Receiver must have unique number
<webprint> Yes/No C Required for importing of web print shipments
(outbound / returns). Needs to be set to Yes for
webprint to work.
Setting needs to be switched on in SmartFreight®
and virtual stationery loaded.
Note: <recemail> and <sendemail> are mandatory
fields if subscribing to Webprint shipments
<recname> String[50] M Receiver Company Name
<recph> String[20] O Receiver Phone Main
<reccontact> String[20] O Receiver Contact Name
<recfax> String[20] O Receiver Facsimile Number
<recmobile> String[20] O Receiver Mobile Number
<recemail> String[100] O Receiver Email Address (Note: Mandatory if client
is using the ASN feature in SmartFreight®. Sender
email <sendemail> must be supplied in the XML
also)
<recgroup1> String[4] O Receiver Group 1 for reporting
<recgroup2> String[4] O Receiver Group 2 for reporting
<recgroup3> String[4] O Receiver Group 3 for reporting
<recgroup4> String[4] O Receiver Group 4 for reporting
<adhocrec> Yes/No O Ad Hoc Receiver (if you do not wish address to be
added permanently to receiver database in
SmartFreight®). Will default to No if not populated.
SmartFreight® - Consignment XML Specifications 32
<recaddr> N/A S Start of Receiver Address
<add1> String[30] M Address Line 1. Normally used for Lvl, Suite, Flr.
Populate with Street details if no Lvl, Suite or Flr
<add2> String[30] O Address Line 2. Street address
<add3> String[50] M Town/Suburb (Refer to Address section of this
document). Length is Country dependant
<add4> String[25] M State (Refer to Address section of this document).
Length is Country dependant
<add5> String[10] M Postcode (Refer to Address section of this
document). Length is Country dependant
<add6> String[30] O Country (Refer to Address section of this
document)
<type> String[50] O R – Residential B – Business PO – PO box
Default is Business
</recaddr> N/A E End of Receiver Address
<sendname> String[30] C Sender Name (Mandatory if more than one sender)
<sendemail> String[100] O Sender Email Address (Note: Mandatory if client is
using the ASN feature in SmartFreight®. Receiver
email <sendemail> must be supplied in the XML
also)
<sendph> String[20] C Sender Phone (Main) (Mandatory if more than one
sender)
<sendaddr> N/A S Start of Sender Address
<add1> String[30] C Address Line 1 (Mandatory if more than one
sender)
<add2> String[30] C Address Line 2
<add3> String[50] C Town/Suburb (Mandatory if more than one sender).
Refer to Address section of this document. Length
is Country dependant
<add4> String[25] C State (Mandatory if more than one sender). Refer
to Address section of this document. Length is
Country dependant
SmartFreight® - Consignment XML Specifications 33
<add5> String[10] C Postcode (Mandatory if more than one sender).
Refer to Address section of this document. Length
is Country dependant
<add6> String[30] O Country
<type> String[50] O R – Residential B – Business PO – PO box
Default is Business
</sendaddr> N/A S End of Sender Address
<chargeto> String[1] O Charge To – Sender (S); Receiver (R); Third Party
(T). Will default to Sender if not populated
<carriername> String[15] C Carrier Name. Must match that contained in
SmartFreight®. SmartFreight® will provide carrier
matrix specific to the site. (Not Required if Least
Cost option <applyleastcost>
<accno> String[15] C Account Number. SmartFreight® will provide
carrier matrix specific to the site (Not Required if
Least Cost option <applyleastcost> set to Yes or If
Fastway is carrier)
<manifestaccno> String[50] O The account number of the owner of the freight. If
omitted, will use the sender’s account number
<service> String[12] C Carrier Service. Must match that contain in
SmartFreight®. SmartFreight® will provide carrier
matrix specific to the site. (Not Required if Least
Cost option <applyleastcost> set to Yes or if
Fastway is Carrier)
<tpyaccno> String[30] C Third Party Account Number (Mandatory if
<chargeto> set to T)
<tpyname> String[50] C Third Party Name (Mandatory if <chargeto> set to
T)
<tpyadhoc> Yes/No C Ad Hoc Third Party (Mandatory if <chargeto> set to
T)
<tpyaddr> N/A C Start of Third Party Address
<add1> String[30] C Address Line 1 (Mandatory if <chargeto> set to T)
<add2> String[30] C Address Line 2
<add3> String[50] C Town/Suburb (Mandatory if <chargeto> set to T).
(Refer to Address section of this document).
Length is Country dependant
SmartFreight® - Consignment XML Specifications 34
<add4> String[25] C State (Mandatory if <chargeto> set to T) (refer to
Address section of this document). Length is
Country dependant
<add5> String[10] C Postcode (Mandatory if <chargeto> set to T) (refer
to Address section of this document). Length is
Country dependant
<add6> String[30] O Country
<type> String[50] O R – Residential B – Business PO – PO box
Default is Business
</tpyaddr> N/A E End of Third party Address
<regname> String[50] O Registered owner of the freight
<regaddr> N/A C Start of Registered Owner Address
<add1> String[30] C Address Line 1
<add2> String[30] C Address Line 2
<add3> String[50] C Town/Suburb. (Refer to Address section of this
document). Length is Country dependant
<add4> String[25] C State (refer to Address section of this document).
Length is Country dependant
<add5> String[10] C Postcode (refer to Address section of this
document). Length is Country dependant
<add6> String[30] O Country
<type> String[50] O R – Residential B – Business PO – PO box
Default is Business
<regaddr> O End of Registered owner address
<rtsname> String[50] O Return to sender name. Mandatory for
international shipments.
<rtsaddr> N/A C Start of Return to Name Address
<add1> String[30] C Address Line 1
<add2> String[30] C Address Line 2
<add3> String[50] C Town/Suburb. (Refer to Address section of this
document). Length is Country dependant
SmartFreight® - Consignment XML Specifications 35
<add4> String[25] C State (refer to Address section of this document).
Length is Country dependant
<add5> String[10] C Postcode (refer to Address section of this
document). Length is Country dependant
<add6> String[30] O Country
<type> String[50] O R – Residential B – Business PO – PO box
Default is Business
<rtsaddr> O End of Return to Name address
<deliverbefore> String[50] O Specifies date and/or time that sender would like shipment delivered by. Format: dd/MM/yyyy HH:mm
<insvalue> Numeric
(9999.99)
C Insurance Value
<inspremium> Numeric
(999.99)
C Insurance Premium
<insclass> String[2] C Insurance Class
<insdesc> String[50] C Insurance description
<foodstuff> Yes/No O Food Stuff being shipped. Will default to No if not populated.
<ccname> String[35] O Cost Centre Name for reporting
<ccdesc> String[50] C Cost Centre description, mandatory if adding cost centres dynamically on import
<surctype> Numeric (99) O Surcharge Type for reporting
<surcdesc> String[30] Export Only. Surcharge description for reporting
<multiplylwh> Yes/No O Yes – Will multiply length, width and height by number of items to obtain cubic volume. No - will assume that dimensions relate to total for that line of freight & will multiple by one to arrive at cubic. Will default to No if not populated
<applyleastcost> Yes/No O If SmartFreight® to select cheapest option for freight & module has been purchased by client. Will default to No if not populated.
<applyfastestdelivery> Yes/No O If SmartFreight® to select fastest option for freight & module has been purchased by client. Will default to No if not populated. NB: this may not be the cheapest possible delivery method.
SmartFreight® - Consignment XML Specifications 36
<applyleastcostwithdeliver> Yes/No O Additional level to Least Cost such that delivery method should be chosen within the time frame specified in the <deliveryleadtime> field. NB: This may not be the cheapest possible delivery method.
<deliveryleadtime> String[10] C On Import: The maximum allowable delivery time, when used with <applyfastestdelivery> or <applyleastcostwithdelivery> On Export: The estimated delivery time for the consignment. Specified in Hours, unless a unit of measure is used. H = Hours D = Days M = Months W = Weeks Examples: 2 = 2 Hours 34H = 34 Hours, 1 day and 10 hours 1D = 1 Day or 24 Hours
<applymarkup> Yes/No O Apply Markup on top of freight for cost recovery purposes & module has been purchased by client. Will default to No if not populated.
<partialimport> Yes/No O Ability if all mandatory data not available to request SmartFreight® to import what information can be provided and allow operator to complete via SmartFreight® screen
<dontsavetoimporterrors> Yes/No O Note: if this tag is set to Yes then SmartFreight®
will generate an error export file but it won’t import
the error shipment into SmartFreight®…the error
will need to be fixed in the clients ERP/WMS and
then reimported to SmartFreight®
<throwexceptiononwserror> Yes/No O When developers want to know that there has
been an error with the web service request but
don’t want to interrogate our response
<limitleastcosttocarrier> Yes/No O Stipulates to the Least Cost Routing Calculation
that only the carrier specified in the <carriername>
field should be considered when applying either
the Fastest, or cheapest delivery.
<applyleastcostmusttrack> Yes/No O Will only select carrier / service if carrier providing
tracking data
<freightmethod> String[50] O Allows you to use a code to represent carrier,
service combinations (Ask local SmartFreight®
Integration Team for further specifics)
<com1> String[30] O Comment 1 Additional internal notes
SmartFreight® - Consignment XML Specifications 37
<com2> String[30] O Comment 2 Additional internal notes
<com3> String[30] O Comment 3 Additional internal notes
<com4> String[30] O Comment 4 Additional internal notes
<com5> String[30] O Comment 5 Additional internal notes
<printer> String[20] O Printer alias to allocate consignment to different
thermal label printers across network
<returnconnote> Y/A O Creates a return consignment in SmartFreight®
Y = Return Connote only.
A = Outgoing + Return Label
<nooffashionlabels> Numeric
(999)
O Reserved for Fashion Industry. Defines number of
labels to be printed for garments being shipped in
Hanging Fashion Bags which will not be equal to
number of garments being shipped
<fullspins> String[90] O Allows one line of special instructions upto 90
characters, which we then split into the 3 special
instructions fields on import. NOTE: cannot be
used in conjunction with <spins>
<spins> N/A S Start of Special Instructions
<sp1> String[30] O Special Instruction 1
<sp2> String[30] O Special Instruction 2
<sp3> String[30] O Special Instruction 3
</spins> N/A E End of Special Instructions
<labels> N/A S Start of Consignment Labels.
<labelno> String[255] C Label Number (Barcode)
<itemreference> String [50] C Allows client to print a reference per label. Note:
requires setting switched on import settings screen
</labels> N/A E End of Consignment labels
<additionalreferences> N/A S Start of Additional references
<referenceno> String[25] O Additional reference Numbers if five lines of
consignment insufficient
</additionalreferences> N/A E End of Additional references
<dgdetails> N/A S Start of Dangerous Goods (DG) detail
SmartFreight® - Consignment XML Specifications 38
<productid> String [30] O Your Product ID to assist with identification within
SmartFreight®
<techname> String[100] C DG Technical Name
<commonname> String [30] C DG Common Name
<class> String [4] C DG Class
<subclass> String [4] C DG Sub-Class if applicable
<packgroup> String [30] C DG Packaging Group
<unnumber> String [7] C DG UN Number
<amt> Numeric(999) C DG Quantity
<size> Numeric
(999.999)
C DG quantity ether in KG, Litres or M3
<um> String [2] C DG Unit of measure. Must be KG or L or M3 (Kilos
or Litres or Volume)
<desc> String [15] C DG Packaging. CARTON OR PALLET OR DRUM
ONLY
<erg> String [10] C DG ERG / Hazchem Code
</dgdetails> N/A E End of Dangerous Goods details
<includesbattery> Yes/No O Forces a Lithium battery manifest
<printbatterylabel> Yes/No O Forces a battery label print per item
<autoconsolidate> Y,N,X,A O Y = Consolidation option available and requires
user input to confirm
N = No consolidation
X = Never Consolidate
A = Always Consolidate
<docsonly> Yes/No O Documents only shipment. International shipment
only.
<incoterms> String (50) International Contact Terms e.g. DDP Delivery
Duty Unpaid. International Shipments Only.
<goodscurrency> String (50) M The Currency that the value of goods is specified
in e.g. AUD, USD, HKD, CNY. Mandatory for
International Shipments
<commercialinvno> String (50) O Commerical invoice number
<freightlinedetails> N/A S Start of Freight Line Details.
SmartFreight® - Consignment XML Specifications 39
(Maximum of 5 detail lines per consignment
allowed)
<ref> String[25] O Reference No. Usually clients internal Order
Number, Job Number, Packing Slip Number or
Invoice Number. Used as ‘common’ field between
two system to write freight data back to
ERP/WMS/Host system
<desc> String[15] M Item description. Must match that contain in
SmartFreight®. SmartFreight® will provide client
specific list relating to freight carriers use by client.
Corresponding data must be entered for Amt &
Wgt
<amt> Numeric
(999)
M Item quantity
<countrymanufacture> String (255) M This is the products country of manufacture.
Please refer to the international shipping
requirements for the country of origin for more
information (Refer to Appendix D for list of
Countries)
<goods> String (MAX) M Goods Description – International Shipments Only.
A brief description of the goods. Certain words are
flagged by the importing customs and quarantine
agencies. As such, you should confer with your
international shipment account manager regarding
appropriate descriptions to be used.
<pieces> Numeric
(9999)
M Number of inner items – International Shipments
Only. This is the total number of units contained
within the specific order/manifest line.
<val> Numeric
(9999.99)
M The total value of goods for this line of freight.
<wgt> Numeric
(99999.99)
M Item weight in Kg
<cube> Numeric
(99999.99)
O Item volume in m3
<len> Numeric
(999)
O Item Length in cm
<hgt> Numeric
(999)
O Item Height in cm
SmartFreight® - Consignment XML Specifications 40
<wdt> Numeric
(999)
O Item Width in cm
<expectedamt> Numeric
(999)
O If Consolidation option used this allows to use
least cost routing if freight data is being drip fed for
a particular order
<expectedwgt> Numeric
(999)
O If Consolidation option used this allows to use
least cost routing if freight data is being drip fed for
a particular order
<expectedcube> Numeric
(99999.99)
O If Consolidation option used this allows to use
least cost routing if freight data is being drip fed for
a particular order
<youritemdesc> String[15] O Can be used to map unique descriptions of freight
to standard carrier compliant shipping descriptions.
Youritemdesc needs to be setup in SmartFreight®
before using.
<cat> String (255) O This is the products general categorisation.
International Shipments only.
<hscode> String (255) O HS code – International Shipments only. The
harmonised commodity description and coding
system value that may be required by customs to
identify the duty and tax rates for specific types of
products. It is a 6 digit code. US imports require
an HTS code (10 digits -> HS code + 4 more
digits). This number can also be entered into this
field.
</freightlinedetails> N/A E End of Freight Line Details
<addsamedescription
linesignoredimensions>
Y O Rolls up freightlines with the same description into
one freightline but ignores the dimensions. Will
default to No if not populated.
<serviceoption> N/A S Start of service options.
<option> See
Appendix C
for all options
O Service options available.
Note: Service options are only available for certain
carriers so please consult SmartFreight® for more
information
<value> String[50] O See Appendix C
</serviceoption> N/A E End of service options
<assets> N/A S Start of Asset Details
SmartFreight® - Consignment XML Specifications 41
<assetname> String[2] C Asset Type.CH = Chep, LO = Loscam. Other
Assets can be setup by user as required
<movement> String[1] C Asset Movement: Transfer (T) or Exchange (E)
(Mandatory if Assets used)
<accountno> String[50] C Account number if asset being transferred.
(Mandatory if Assets used & being transferred)
<logto> String[1] C Entity Type – Receiver (R) Carrier (C) (Mandatory
if Assets used)
<quantity> Numeric
(9999)
C Asset Quantity (Mandatory if Assets used)
</assets> N/A E End of Asset Details
<conno> String[25] N/A Export Only.
Consignment Note Number including prefix
allocated to shipment. NB Most carriers track
freight by this field
<labelno_tracking> String[] N/A Export Only
If client is shipping with the carrier Fastway then
this field, must be used to track freight. In fact, this
field can be used to track shipments for all carriers.
<conprfx> String[50] N/A Export Only.
Consignment Note Prefix
<creatorid> String[30] N/A Export Only.
User friendly name of last person to access
consignment before being manifested if function
activated by client
<carrzone> String [50] N/A Export Only.
Carrier Rates Zone consignment shipped to
<totitems> Numeric
(9999)
N/A Export Only.
Total items shipped on consignment
<totwgt> Numeric
(99999.99)
N/A Export Only.
Total dead weight in KG of consignment
<totcube> Numeric
(9999.9999)
N/A Export Only.
Total Cubic of consignment
<chgwgt> Numeric
(9999.99)
N/A Export Only.
SmartFreight® - Consignment XML Specifications 42
Weight (Greater of Dead Weight versus Cubic size)
which is what freight will be priced on by both
SmartFreight® & freight carrier
<rate> Numeric
(Currency)
N/A Export Only.
The freight charge ex Tax.
<totlevy> Numeric
(Currency)
N/A Export Only.
The charge for all and any levies (eg. Security,
Fuel) ex Tax
<inspremium> Numeric
(Currency)
N/A Export Only.
Insurance Premium paid ex Tax
<surccharge> Numeric
(Currency)
N/A Export Only.
Total of Surcharges (eg. Saturday Delivery) ex Tax
<totsurchrg> Numeric
(Currency)
N/A Export Only.
Total Surcharges. = ToyLevy + InsPremium +
SurcCharge exTax
<totdgchrg> Numeric
(Currency)
N/A Export Only.
Dangerous Goods charge ex tax.
<totcost> Numeric
(Currency)
N/A Export Only.
Total Cost of Freight ex tax. = Rate + TotSurChrg
+ TotDGChrg
<gstamount> Numeric
(Currency)
N/A Export Only.
Tax on TotCost
<grandtotrate> Numeric
(Currency)
N/A Export Only.
TotCost including Tax
<mrkupchrg> Numeric
(Currency)
O Export Only normally but Import possible
The amount of markup applied, as a currency
value
Normally only calculated by SmartFreight® from
Markup Rules set in SmartFreight® database but
can be imported by client if specific amount to be
added to consignment that needs to override data
in SmartFreight®
<totcostplusmrkup> Numeric
(Currency)
N/A Export Only.
The markup applied plus the total freight cost ex
tax = TotCost + MrkupChrg
SmartFreight® - Consignment XML Specifications 43
<gstonmrkup> Numeric
(Currency)
N/A Export Only.
Tax on the TotCostPlusMrkup
<grandtotmrkup> Numeric
(Currency)
N/A Export Only.
Grand total of = TotCostPlusMrkup + GSTOnMrkup
</connote> N/A E End of Connote
SmartFreight® - Consignment XML Specifications 44
Appendix C: Service Options
Option Value
NDBEFORETIME Valid values are any time values. Format is HHmm. Examples:
0900
1030
1700 etc.
DAY Mon - Sun
DATE Format of date is: yyyyMMdd. Eg. 20160101
DAYTIME Format is: ddd HHmm. Eg. Mon 0900
DATETIME Format is: yyyyMMdd HH:mm eg. 20160101 12:00
DATEAMPM Format is: yyyyMMdd AM/PM eg. 20160101 AM
DAYAMPM Format is: ddd AM/PM eg. Mon AM, Tue PM
AUTHORITYTOLEAVE Startrack Express specific only. PLEASE USE ATL. Valid values are:
Y Yes N No
ATL Authority to leave instruction. Valid values are:
Y Yes
N No
SmartFreight® - Consignment XML Specifications 45
Appendix D: List of Countries (ISO 3166)
Country
AFGHANISTAN
ALAND ISLANDS
ALBANIA
ALGERIA
AMERICAN SAMOA
ANDORRA
ANGOLA
ANGUILLA
ANTARCTICA
ANTIGUA AND BARBUDA
ARGENTINA
ARMENIA
ARUBA
AUSTRALIA
AUSTRIA
AZERBAIJAN
BAHAMAS
BAHRAIN
BANGLADESH
BARBADOS
BELARUS
BELGIUM
BELIZE
BENIN
BERMUDA
BHUTAN
BOLIVIA
BOSNIA AND HERZEGOWINA
BOTSWANA
BOUVET ISLAND
BRAZIL
BRITISH INDIAN OCEAN TERRITORY
SmartFreight® - Consignment XML Specifications 46
BRUNEI DARUSSALAM
BULGARIA
BURKINA FASO
BURUNDI
CAMBODIA
CAMEROON
CANADA
CAPE VERDE
CAYMAN ISLANDS
CENTRAL AFRICAN REPUBLIC
CHAD
CHILE
CHINA
CHRISTMAS ISLAND
COCOS (KEELING) ISLANDS
COLOMBIA
COMOROS
CONGO, Democratic Republic of (was Zaire) CONGO, Republic of
COOK ISLANDS
COSTA RICA
COTE D'IVOIRE
CROATIA (local name: Hrvatska)
CUBA
CYPRUS
CZECH REPUBLIC
DENMARK
DJIBOUTI
DOMINICA
DOMINICAN REPUBLIC
ECUADOR
EGYPT
EL SALVADOR
EQUATORIAL GUINEA
SmartFreight® - Consignment XML Specifications 47
ERITREA
ESTONIA
ETHIOPIA
FALKLAND ISLANDS (MALVINAS)
FAROE ISLANDS
FIJI
FINLAND
FRANCE
FRENCH GUIANA
FRENCH POLYNESIA
FRENCH SOUTHERN TERRITORIES
GABON
GAMBIA
GEORGIA
GERMANY
GHANA
GIBRALTAR
GREECE
GREENLAND
GRENADA
GUADELOUPE
GUAM
GUATEMALA
GUINEA
GUINEA-BISSAU
GUYANA
HAITI
HEARD AND MC DONALD ISLANDS
HONDURAS
HONG KONG
HUNGARY
ICELAND
INDIA
INDONESIA
SmartFreight® - Consignment XML Specifications 48
IRAN (ISLAMIC REPUBLIC OF)
IRAQ
IRELAND
ISRAEL
ITALY
JAMAICA
JAPAN
JORDAN
KAZAKHSTAN
KENYA
KIRIBATI
KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF KOREA, REPUBLIC OF
KUWAIT
KYRGYZSTAN
LAO PEOPLE'S DEMOCRATIC REPUBLIC LATVIA
LEBANON
LESOTHO
LIBERIA
LIBYAN ARAB JAMAHIRIYA
LIECHTENSTEIN
LITHUANIA
LUXEMBOURG
MACAU
MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF MADAGASCAR
MALAWI
MALAYSIA
MALDIVES
MALI
MALTA
MARSHALL ISLANDS
MARTINIQUE
SmartFreight® - Consignment XML Specifications 49
MAURITANIA
MAURITIUS
MAYOTTE
MEXICO
MICRONESIA, FEDERATED STATES OF
MOLDOVA, REPUBLIC OF
MONACO
MONGOLIA
MONTSERRAT
MOROCCO
MOZAMBIQUE
MYANMAR
NAMIBIA
NAURU
NEPAL
NETHERLANDS
NETHERLANDS ANTILLES
NEW CALEDONIA
NEW ZEALAND
NICARAGUA
NIGER
NIGERIA
NIUE
NORFOLK ISLAND
NORTHERN MARIANA ISLANDS
NORWAY
OMAN
PAKISTAN
PALAU
PALESTINIAN TERRITORY, Occupied
PANAMA
PAPUA NEW GUINEA
PARAGUAY
PERU
SmartFreight® - Consignment XML Specifications 50
PHILIPPINES
PITCAIRN
POLAND
PORTUGAL
PUERTO RICO
QATAR
REUNION
ROMANIA
RUSSIAN FEDERATION
RWANDA
SAINT HELENA
SAINT KITTS AND NEVIS
SAINT LUCIA
SAINT PIERRE AND MIQUELON
SAINT VINCENT AND THE GRENADINES SAMOA
SAN MARINO
SAO TOME AND PRINCIPE
SAUDI ARABIA
SENEGAL
SERBIA AND MONTENEGRO
SEYCHELLES
SIERRA LEONE
SINGAPORE
SLOVAKIA
SLOVENIA
SOLOMON ISLANDS
SOMALIA
SOUTH AFRICA
SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS SPAIN
SRI LANKA
SUDAN
SURINAME
SmartFreight® - Consignment XML Specifications 51
SVALBARD AND JAN MAYEN ISLANDS
SWAZILAND
SWEDEN
SWITZERLAND
SYRIAN ARAB REPUBLIC
TAIWAN
TAJIKISTAN
TANZANIA, UNITED REPUBLIC OF
THAILAND
TIMOR-LESTE
TOGO
TOKELAU
TONGA
TRINIDAD AND TOBAGO
TUNISIA
TURKEY
TURKMENISTAN
TURKS AND CAICOS ISLANDS
TUVALU
UGANDA
UKRAINE
UNITED ARAB EMIRATES
UNITED KINGDOM
UNITED STATES
UNITED STATES MINOR OUTLYING ISLANDS URUGUAY
UZBEKISTAN
VANUATU
VATICAN CITY STATE (HOLY SEE)
VENEZUELA
VIET NAM
VIRGIN ISLANDS (BRITISH)
VIRGIN ISLANDS (U.S.)
WALLIS AND FUTUNA ISLANDS
SmartFreight® - Consignment XML Specifications 52
WESTERN SAHARA
YEMEN
ZAMBIA
ZIMBABWE