ConsignmentService - Specification 1.42

ICS Australia
Consignment Web Service Specification
TNT Australia
Consignment Web Service
Version 1.4
Title: Consignment Service Specification Page 1 of 44

Issue Status: 1.4
ICS Australia
CONTENTS
1 Introduction....................................................................................................................3
1.1 Service Actions........................................................................................................3
1.2 Supported TNT Express Services...........................................................................4
* please note the service code for both services is 717; when using Sensitive Express
you MUST also provide the commodity code “B” in the CommodityCode field in the
PackageLine object...........................................................................................................4
1.3 Validation.................................................................................................................4
2 Consignment Web Service............................................................................................5
2.1 System Overview....................................................................................................5
2.2 Service Details........................................................................................................5
2.3 Authentication.........................................................................................................6
3 API Functions and Parameters......................................................................................7
3.1 Process Consignment Request..............................................................................7
3.1.1 Process Consignment Request Example......................................................20
3.2 Process Consignment Response.........................................................................27
3.2.1 Routing Data Example...................................................................................29
3.2.2 Response Example (Routing)........................................................................31
3.3 Reprint Label Request..........................................................................................33
3.3.1 Reprint Label Request Example....................................................................34
3.4 Reprint Label Response.......................................................................................34
3.4.1 Response Example (Reprint).........................................................................36
3.5 Client side setting when using .net.......................................................................37
4 Error Handling..............................................................................................................37
4.1 Schema Validation Error.......................................................................................37
4.1.1 Scenario.........................................................................................................37
4.1.2 Schema Validation Error Example.................................................................37
4.2 Service Process Error...........................................................................................39
4.2.1 Possible Error Codes.....................................................................................39
4.2.2 Error Response Example...............................................................................41
5 Label Types.................................................................................................................42
5.1 Label Type A – Plain paper...................................................................................42
5.2 Label Type B – eCon Paper Stock........................................................................43

Issue Status: 1.4
ICS Australia
1 Introduction
TNT’s Web Consignment Service is an XML based system which incorporates label creation, dynamic web
routing and manifest data transfer submission.
This service also provides a reprint label function for reprinting consignments labels that were submitted via
this service.
This document provides technical specifications as follows:
1.1 Service Actions
This service provides three possible actions:
Label Creation
This function provides the ability to return fully compliant TNT routing label/s based on shipment data
provided. The label is returned as a string of binary data and can be printed as a pdf once decoded. There
are three possible paper stocks:
1. Type A - A4 Plain Paper – This version prints a consignment note on one piece of paper and then
each of the address labels on a separate page according to the number of items being shipped.
2. Type B - TNT e-Con stationary – This version prints labels to suit TNT supplied e-Con A4 stationary
which provides two sticky labels and one consignment note per page. (* please note – if you have
more than 2 items the consignment note portion will only print on the first page)
3. Type C - Thermal Label stock – This prints only the address label element to suit TNT’s standard
CIT label format of 150mmx 101mm (6”x4”)
Dynamic Web Routing

This action returns the four routing elements TNT requires to be displayed on the label to ensure freight is
correctly routed and delivered.
 Origin Depot Code
 Gateway Depot Code
 Destination Depot Code
 Sort Bin Number
Data Submission
This provides a facility to present to TNT both interim (sortation), and final consignment data
The interim shipping data service allows you to send incremental consignment information throughout the
day to enable TNT to commence sortation and collection planning. Interim data is essential for sorting
freight that is collected prior to the end of day manifest process. This allows our auto-sortation systems to
accurately sort your freight.
* Please note that implementation of label creation, or dynamic web routing functions will also provide
interim data files. TNT creates interim manifest data from the information provided in the XML request.
To finalise each day’s shipments, an end of day request must be submitted with totals for all consignments
picked up that day.

Issue Status: 1.4
ICS Australia
1.2 Supported TNT Express Services

The list of services supported by this product are:
Service Code Service Description
76 Road Express
75 Overnight Express
73 Overnight PAYU Satchel
712* 9:00 Express
EX10* 10:00 Express
EX12* 12:00 Express
718 Fashion Express
701 National Sameday
717 /B* Premium / Sensitive Express
* please note the service code for both services is 717; when using Sensitive Express you MUST also provide the commodity code
“B” in the CommodityCode field in the PackageLine object.
1.3 Validation
TNT validates data to ensure compliance. The two most common items that cause errors are:
 Suburb/Postcode validation. TNT Express’ routing is critical to the effective and efficient transport
of our customer’s freight and relies on accurate suburb and postcode combinations. Part of the
routing validation is to confirm that the supplied collection and delivery locations are correct.
Common areas for issues are:
o Abbreviations ie Mt instead of Mount, Crk instead of Creek etc…
o Town/Suburb descriptives - ie North Manly is correct Manly North is not. Though Manly
West is correct.
o P.O and G.P.O postcodes are not valid delivery or collection locations.
o Incorrect postcode and suburb combinations ie Sydney NSW 2010

(We suggest you use Australia Post’s suburb listing to validate)
 Time Definite service validation. TNT Express has three priority services that offer a time definite
delivery. They are 9:00, 10:00 and 12:00 Express. These services are limited to a set of collection
and delivery locations. The fall back service is TNT Express’ Overnight Express which is available
Australia wide.
If you intend to use TNT Express’ Time Definite Services it is suggested that you pre-validate your collection
and delivery locations are valid for your chosen service by using TNT Express’ Rated Transit Times (RTT)
service. RTT will provide a list of valid services between a collection and delivery set. (please discuss RTT
with you local CIT Coordinator)

Issue Status: 1.4
ICS Australia
2 Consignment Web Service

This document describes the interface exposed by the Consignment Web Service API. It details the request
and response schema, the system error messages and business rules associated with the system.
2.1 System Overview

The Consignment Web Service provides an interface for TNT customers to submit request of consignment
action. The service has been designed for integration into the software or websites of TNT customers. The
system overview is presented in figure 1, the client application will make an HTTP POST request over SSL
and a SOAP-XML document will be returned.
Figure 1. Physical View
Figure 2. Logical View

2.2 Service Details
The Consignment Web Service is a WCF/SOAP based web service.
The service is compatible with and intended to be used by SOAP based clients.
Raw HTTP request examples are included for non SOAP based clients.
Test Web Service WSDL Location

https://uat.tntexpress.com.au/Webservices/Conservice/ConsignmentService.svc?wsdl
Production Web Service WSDL Location

https://www.tntexpress.com.au/Webservices/Conservice/ConsignmentService.svc?wsdl
Testing is performed within TNT’s UAT environment and once tested and approved can be moved into the
production site.

Issue Status: 1.4
ICS Australia
2.3 Authentication
You must be registered for TNT Online in order to access this API and the services will only be available for
registered TNT account numbers.
Once registered, you will be allocated a UserID which will be used in combination with your TNT Online
password to authenticate each Consignment Web Service request. The UserID comprises of the three
alpha CIT, followed by a unique 17 digit number, eg:
CIT00000000000001947
The password will be your TNT online password.
The following items are linked to your UserID:

 Account Number/s
 Sender Code and Prefix combinations.
The TNT CIT Service Desk can be contacted to set up the UserID. If you already have a TNT UserID you
use for other TNT APIs, your existing UserID will just need to be authorised to access this service.
The contact number for the CIT Service Desk is 1300 8151 131.

Issue Status: 1.4
ICS Australia
3 API Functions and Parameters

The service implements the following functions
 ProcessConsignmentRequest
 ReprintLabelRequest
The function ProcessConsignmentRequest takes ConsignmentRequest object as input parameter.

The function ReprintLabelRequest takes ConsignmentReprintRequest object as input parameter.
3.1 Process Consignment Request

This function will return data based on request action.
Consignment Request Object

This is the top level request object for ProcessConsignmentRequest method
Name Data Type Required Description Example
ConsignmentProcessList List of Consignment Process Minimum 1
Objects object
Username String(20) Y The userid provided by CIT representative CIT00000000000001947
Password String(30) Y The password associated with the userid LetMeIn

Issue Status: 1.4
ICS Australia
ConsignmentProcess Object
Consignment Object Y
ConsignmentActionList List of Y Request the desired output  GETROUTINGDATA
Consignment Action Type  GETLABEL
Object
 SUBMIT
Extraoptions List of N For future use of additional objects.
Extra option Object
SenderCode String(15) Y Sender Identification Code TNT assigned. ABCDE
Five character Site ID linked to
consignment prefix.
LabelType Enum Print Layout Type N Define what type of label layout to print. A – Plain A4 Paper
Object Refer to Section 5 B – eCon Stock
C – Thermal TNT Labels
Required when “GETLABEL” action is
present.
Consignment Object
ConsignmentNumber String(15) Y Standard consignment number format ABC123456789
comprises three alpha + nine numeric.
TNT assigns your three letter prefix the
following nine digits are provided by the
customer.
PayingAccount String(10) Y TNT account to be charged. Must be a 99999999
valid TNT account or freight costs will
revert to account held against
sendercode/prefix used.
Collection Address Object Y Refer to Address Object. Where the

Issue Status: 1.4
ICS Australia
shipment is to be collected / picked up

from.
ReceiverIndentiferCode String(15) N N/A
Delivery Address Object Y Refer to Address Object. Where the
shipment is to be delivered to.
ConsignmentDate String(8) Y Date in format DDMMCCYY 10112014
ServiceCode String(4) Y TNT assigned.
“701” – Sameday
“712” – 9:00 Express*
“X10” – 10:00 Express*
“X12” – 12:00 Express*
“73” – ONFC - Satchel
“75” – Overnight Express
“76” – Road Express
“718” – Fashion Express
““717” – Premium or Sensitive Express1
1
Commodity code “B” required for
Sensitive Express in Consignment Line
Object
* specific origin/destination combinations
only! TNT’s Rated Transit Times web
service provides validation.
DangerousGoodsIndicator Enum of Indicator Type Y Refer to Indicator Type object Y/N
Payer Enum of Payer Type Y Refer to Payer Type object S/R/T
Foodindicator Enum of Indicator Type Y Refer to Indicator Type object Y/N
CancelIndicator Enum of Indicator Type Y Refer to Indicator Type object Y/N

Issue Status: 1.4
ICS Australia
ExtendedWarrantyValue Int (8) N Enter amount of coverage required. Max

$10,000
ExtendedWarrantyClass Enum Extended Warranty N “A”, “B” or “C”
Type
Should only be populated where
Extended Warranty Value is not blank.
AdditionalServiceList List of N Refer to Additional Service Type object.
Additional Service Type Used for eReturns only. Use code RET.
Object
HandRateAmount Decimal N Not used leave blank
OtherCharges Decimal N Not used leave blank
CustomerConsignmentRef String(30) N Optional except when one of Additional RET
Service 1-5 = “RET” in which case this
field must contain the Return Authority
Number
ConsignmentFinaliseIndicator Enum of Indicator Type Y Signifies if consignment details are final or Y/N
interim.
Refer to Indicator Type object
ThirdParty Third Party Object N Refer to Third Party object
ConsignmentSpecialInstruction List of Consignment Special N Used to provide delivery or collection “Please deliver to reception”
List Instruction Object instructions
PackageLineList List of Y Refer to Package Line object
Package Line Minimum of 1
DangerousGoodsList List of Dangerous Goods N Refer to Dangerous Goods object
ItemIdentifierList List of Item Identifier N If using GetLabel action, item identifiers
will be generated by TNT.
If using SSCC item numbers. 20
character SSCC item numbers must be
supplied in this field. Refer to Item
Identifier

Issue Status: 1.4
ICS Australia
(please note only GetRoutingData and

Submit activities available when using
SSCC)
CustomerReferenceList List of Customer Reference N Required for Deliver on Date.
Object
Refer to Customer Reference object
AlertAddressList List of Alert Address Object N Refer to Alert Address object
ConsignmentKeepInstore Consignment Keep In Store N Refer to Consignment Keep In Store
Object object
ConsignmentPickup Consignment Pickup Object N Refer to Consignment Pickup object
ConsignmentSpecialReference List of Consignment Special N Refer to Consignment Special Reference
List Reference object object
Address Object
Name String(30) Y Company or Persons name ABC Company or Joe Citizen
Address1 String(30) Y First address line
Address2 String(30) N Second optional address line
Suburb String(30) Y Valid Australian suburb/town name
State String(3) Y “ACT”, “NSW”, “QLD”, “SA ”,“TAS”, “VIC”,
“WA ”, “NT ”
Postcode String(4) Y Valid matching postcode
ContactName String(20) N
Phone String(13) N

Issue Status: 1.4
ICS Australia
Third Party Object

ThirdPartyIdCode String(15) N Not Required.
ThirdPartyAddress Address Object Y* Refer to Address object. Must be supplied
if Payor Type = T
Consignment Special Instruction Object

TextType Enum Special Instruction Text Y
Type
TextLIne String(80) N
Package Line Object

LineSequence Int Y Sequential number to ID package line.
Max items at both item and consignment
total is 99
LineCustomerReference String(15) N Package line customer reference
DescriptionOfGoods String(20) N Description of packaging CARTON
CommodityCode String(6) N Used in conjunction with service code to B
identify service. Only service 717
currently.
ItemQuantity Int (5) max items at both item Y Number of Items of this line
and consignment total is 99
LineWeight Decimal (9.3) Y The total weight of all items of this line
WeightMeasureUnit Enum of weight Type Y Weight unit kilos or grams KG / GR
Issue Status: 1.4
ICS Australia
ItemLength Decimal (7.3) Y Length of largest dimension Item

Not validate
ItemWidth Decimal (7.3) Y Width of largest dimension Item
Not validate
ItemHeight Decimal (7.3) Y Height of largest dimension Item
Not validate
DimensionMeasureUnit Enum of DimensionType Y Refer to DimensionType
LineVolume Decimal (10.4) Y Total volume of all items in this line
Not validate
VolumeMeasureUnit Enum of Volume Type Y Refer to Volume Type cubic meters or CO (meters) or CC (centimetres)
cubic centimetres
Dangerous Goods Object - Optional

LineSequence Int Y
ProductSequence Int Y
ProductWeight Double Y
WeightMeasureUnit Enum of Weight Type Y Refer to Enum of Weight Type object
HazardMaterialClassType String(1) Y
HazardMaterialClassCode String(4) Y
HazardMaterialClassName String(80) Y
PrincipleRiskClass String(10) Y
PackageGroupCode String(10) Y

Issue Status: 1.4
ICS Australia
Item Identifiers Object

ItemIdentifier String(20) Y Unique item identifier - If using
GetLabel action, item identifiers will be
generated by TNT.
Supply if using SSCC (only
GetRoutingData and Submit activities
available), 20 character SSCC item
numbers must be supplied in this field.
ItemReference String(30) N Item reference for corresponding item

identifier
Customer Reference Object

Sequence Int Y Maximum 1.
CustomerReferenceTextType Enum Y Refer to Customer Reference Text Type DOD
object
CustomerReferenceTextLIne String(10) Y The customer reference text as defined 11082014
by text type.
DOD date format ddmmyyyy

Issue Status: 1.4
ICS Australia
Alert Address Object

AlertType Enum Y Refer to Alert Type object
AlertAddressType Enum Y Refer to Alert Address Type object
AlertAddress String(80) Y Detail of who/what to send the alert
message to. Depending on the value of
Address Type it will be an email
address, telephone number or GSM
mobile device number.
Consignment Keep In Store Object

KeepUntilDow1 String(3) N “Mon”, “Tue”, “Wed”, “Thu”, “Fri”
Consignment Pickup Object

BookingNumber String(15) N Booking or Reference number
FreightReadyTime String(4) N HHMM
PremisCloseTime String(4) N HHMM

Issue Status: 1.4
ICS Australia
Consignment Special Reference Object

SpecialRefText String(8) Y Customer’s special reference text. Eight
fields of eight characters. These do print
on the label.
Consignment Action Type Object

ConsignmentActionType Enum Y Refer to Consignment Action Type GETROUTINGDATA
object
GETLABEL
SUBMIT
Extra Option Object

OptionName String(20) Y Option name defined by TNT
OptionValue String(20) Y Option value defined by TNT
Section Break

Issue Status: 1.4
ICS Australia
Indicator Type Enum Object

Value Description
N Defines No
Y Defines Yes
Extended Warranty Type Enum Object

Value Description
NONE Default value
(when element not provided)
A
B
C
Payer Type Enum Object

Value Description
S Paid by Sender (Default Value)
R Paid by Receiver
T Paid by Third Party
Consignment Action Type Enum Object

Value Description
GETROUTINGDATA Return Routing data for the consignment
GETLABEL Return byte array of label in pdf format
SUBMIT Submit data and only return status and error message
when error occurs
Print Layout Type Enum Object

Value Description
UNSPECIFIED Default
(when element not provided)
A A4 – for Blank paper
B A4 – for eCon stationary
C Thermal

Issue Status: 1.4
ICS Australia
Weight Type Enum Object

Value Description
KG Kilograms (Default Value)
GR grams
Dimension Type Enum Object

Value Description
MR Metres (Default Value)
CM Centimetres
Volume Type Enum Object

Value Description
CO Cubic metres (Default Value)
CC Cubic centimetres
Customer Reference Text Type Enum Object

Value Description
UNSPECIFIED Default
(when element is not provided)
DOD Due On Delivery restriction
Special Instruction Text Type Enum Object

Value Description
UNSPECIFIED Default value
Special instruction text will be ignored
DELIVERY print text in delivery special instructions box on
consignment label /note
PICKUP print text in pickup special instructions box on pickup
labels/manifest for eReturns

Issue Status: 1.4
ICS Australia
Alert Type Enum Object

Value Description
CP Collection Planning
DA delivery notification
FA e-Return futile notification
IP immediate pre-alert
OB onboard notification
OP overnight pre-alert
SA e-Return status notification
SD Sameday delivery notification
SP Sameday pickup notification
Alert Address Type Enum Object

Value Description
E Email address
P Telephone
S GSM mobile device (for SMS receipt)
Additional Service Type Enum Object

Value Description
RET Return Consignment

Issue Status: 1.4
ICS Australia
3.1.1 Process Consignment Request Example

Below is a complete HTTP request including http headers.
Note the SoapAction header this is very important.
POST http://localhost:56257/ConsignmentService.svc HTTP/1.1

Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "http://tempuri.org/IConsignmentService/ProcessConsignmentRequest"
Content-Length: 14080
Host: localhost:56257
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConsignmentService"
xmlns:con1="http://schemas.datacontract.org/2004/07/ConsignmentLibrary">
<soapenv:Header/>
<soapenv:Body>
<tem:ProcessConsignmentRequest>

<tem:Request>
<con:UserName>xxxxxx</con:UserName>
<con:Password>yyyyyyyyy</con:Password>

<con:ConsignmentProcessList>

<con:ConsignmentProcess>
<con:consignment>
<con1:consignmentNumber>ABC123456789</con1:consignmentNumber>
<con1:payingAccount>123456789</con1:payingAccount>
<con1:collection>
<con1:Name>collection name</con1:Name>
<con1:Address1>col street</con1:Address1>

<con1:Address2>?</con1:Address2>
<con1:Suburb>Sydney</con1:Suburb>
<con1:State>NSW</con1:State>
Issue Status: 1.4
ICS Australia
<con1:Postcode>2000</con1:Postcode>

<con1:ContactName>?</con1:ContactName>

<con1:Phone>?</con1:Phone>
</con1:collection>

<con1:receiverIdentifierCode>?</con1:receiverIdentifierCode>
<con1:delivery>
<con1:Name>Receiver Company</con1:Name>
<con1:Address1>test road</con1:Address1>

<con1:Suburb>Melbourne</con1:Suburb>
<con1:State>VIC</con1:State>
<con1:Postcode>3000</con1:Postcode>


</con1:delivery>
<con1:consignmentDate>04122014</con1:consignmentDate>
<con1:serviceCode>76</con1:serviceCode>
<con1:dangerousGoodsIndicator>N</con1:dangerousGoodsIndicator>
<con1:payer>S</con1:payer>
<con1:foodIndicator>N</con1:foodIndicator>
<con1:cancelIndicator>N</con1:cancelIndicator>

<con1:extendedWarrantyValue>2000</con1:extendedWarrantyValue>
<con1:extendedWarrantyClass>NONE</con1:extendedWarrantyClass>

<con1:additionalServiceList>
<con1:AdditionalServiceType>RET</con1:AdditionalServiceType>
</con1:additionalServiceList>

<con1:handRateAmount>0</con1:handRateAmount>

Issue Status: 1.4
ICS Australia

<con1:otherCharges>0</con1:otherCharges>

<con1:customerConsignmentRef>cust con ref</con1:customerConsignmentRef>
<con1:consignmentFinaliseIndicator>N</con1:consignmentFinaliseIndicator>

<con1:thirdParty>

<con1:thirdPartyIdCode>?</con1:thirdPartyIdCode>

<con1:thirdPartyAddress>
<con1:Name>?</con1:Name>

<con1:Suburb>?</con1:Suburb>
<con1:State>?</con1:State>
<con1:Postcode>?</con1:Postcode>


</con1:thirdPartyAddress>
</con1:thirdParty>

<con1:consignmentSpecialInstructionList>
<con1:ConsignmentSpecialInstruction>

<con1:textType>DELIVERY</con1:textType>

<con1:textLine>knock on door</con1:textLine>
</con1:ConsignmentSpecialInstruction>
</con1:consignmentSpecialInstructionList>
<con1:packageLineList>
<con1:PackageLine>

Issue Status: 1.4
ICS Australia
<con1:lineSequence>1</con1:lineSequence>

<con1:lineCustomerReference>first sender re</con1:lineCustomerReference>

<con1:descriptionOfGoods>boat</con1:descriptionOfGoods>

<con1:commodityCode>?</con1:commodityCode>
<con1:itemQuantity>7</con1:itemQuantity>
<con1:lineWeight>19</con1:lineWeight>
<con1:weightMeasureUnit>KG</con1:weightMeasureUnit>

<con1:itemLength>10</con1:itemLength>

<con1:itemWidth>20</con1:itemWidth>

<con1:itemHeight>30</con1:itemHeight>
<con1:dimensionMeasureUnit>CM</con1:dimensionMeasureUnit>

<con1:lineVolume>0</con1:lineVolume>
<con1:volumeMeasureUnit>CC</con1:volumeMeasureUnit>

<con1:articleQuantity>0</con1:articleQuantity>

<con1:garmentQuantity>0</con1:garmentQuantity>
</con1:PackageLine>
<con1:PackageLine>

<con1:lineCustomerReference>SEC sender re</con1:lineCustomerReference>

<con1:descriptionOfGoods>cat</con1:descriptionOfGoods>

<con1:commodityCode>?</con1:commodityCode>
<con1:itemQuantity>7</con1:itemQuantity>
<con1:lineWeight>19</con1:lineWeight>


Issue Status: 1.4
ICS Australia
<con1:itemLength>10</con1:itemLength>

<con1:itemWidth>20</con1:itemWidth>

<con1:itemHeight>30</con1:itemHeight>
<con1:dimensionMeasureUnit>CM</con1:dimensionMeasureUnit>

<con1:lineVolume>0</con1:lineVolume>
<con1:volumeMeasureUnit>CC</con1:volumeMeasureUnit>

<con1:articleQuantity>0</con1:articleQuantity>

<con1:garmentQuantity>0</con1:garmentQuantity>
</con1:PackageLine>
</con1:packageLineList>

<con1:dangerousGoodsList>
<con1:DangerousGoods>
<con1:productSequence>1</con1:productSequence>
<con1:productWeight>3</con1:productWeight>
<con1:hazardMaterialClassType>?</con1:hazardMaterialClassType>
<con1:hazardMaterialClassCode>?</con1:hazardMaterialClassCode>
<con1:hazardMaterialClassName>?</con1:hazardMaterialClassName>
<con1:principleRiskClass>?</con1:principleRiskClass>
<con1:packageGroupCode>?</con1:packageGroupCode>
</con1:DangerousGoods>
</con1:dangerousGoodsList>

<con1:itemIdentifierList>
<con1:ItemIdentifiers>
<con1:ItemIdentifier>?</con1:ItemIdentifier>

<con1:ItemReference>?</con1:ItemReference>

Issue Status: 1.4
ICS Australia
</con1:ItemIdentifiers>
</con1:itemIdentifierList>

<con1:customerReferenceList>
<con1:CustomerReference>
<con1:sequence>1</con1:sequence>
<con1:customerReferenceTextType>UNSPECIFIED</con1:customerReferenceTextType>
<con1:customerReferenceTextLine>?</con1:customerReferenceTextLine>
</con1:CustomerReference>
</con1:customerReferenceList>

<con1:alertAddressList>
<con1:AlertAddress>
<con1:alertType>DA</con1:alertType>
<con1:alertAddressType>E</con1:alertAddressType>
<con1:alertAddress>?</con1:alertAddress>
</con1:AlertAddress>
</con1:alertAddressList>

<con1:consignmentKeepInStore>

<con1:KeepUntilDow1>MON</con1:KeepUntilDow1>

</con1:consignmentKeepInStore>


<con1:consignmentSpecialReferenceList>
<con1:ConsignmentSpecialRef>
<con1:SpecialRefText>?</con1:SpecialRefText>
</con1:ConsignmentSpecialRef>
</con1:consignmentSpecialReferenceList>
</con:consignment>
<con:consignmentActionList>

Issue Status: 1.4
ICS Australia

<con1:ConsignmentActionType>GETLABEL</con1:ConsignmentActionType>
</con:consignmentActionList>

<con:extraOptions>
<con1:ExtraOption>
<con1:OptionName>?</con1:OptionName>
<con1:OptionValue>?</con1:OptionValue>
</con1:ExtraOption>
</con:extraOptions>
<con:senderCode>ADEAX</con:senderCode>

<con:labelType>A</con:labelType>
</con:ConsignmentProcess>
</con:ConsignmentProcessList>
</tem:Request>
</tem:ProcessConsignmentRequest>
</soapenv:Body>
</soapenv:Envelope>

Issue Status: 1.4
ICS Australia
3.2 Process Consignment Response

The method ProcessConsignmentRequest in Consignment Web Service returns ConsignmentResponse
Object.
ConsignmentResponse Object
Name Data Type Description Example
ConsignmentProcessResultList List of Consignment List of process result for
Process Result Object each consignment
Error ErrorResponse Object Response status for the
main request
Status Enum of
Response status Object
Error Response Object

Code String The error code 003
Message String The error message User Authentication
Failed.
Consignment Process Result Object

ConsignmentNumber String
ConsignmentActionList List of generic object
based on action type
Generic Object - Routing Response Object when actiontype = “GETROUTINGDATA”

BinNumber String The routing bin number 20123
OriginDepot String The origin depot SYD
GatewayDepot String The gateway depot SYD
OnForwardingDepot String The routing on forwarding depot SYD
PostCode String The routing destination postcode REDFERN
Suburb String The routing destination suburb 2016
IsServiceSupported Boolean Is the service valid for this TRUE
collection/delivery combination
Status Enum of
Response status
Object
Issue Status: 1.4
ICS Australia
Errors List of Error

Response Object
Generic Object – Create Label Response Object when actiontype = “GETLABEL”

LabelPDF Byte[] PDF data. Decode using Base64. 20123
Status Enum of
Response status
Object
Response Object
Generic Object – Submit Data Response Object when actiontype = “SUBMIT”

Status Enum of
Response status
Object
Response Object
Response Status Enum Object

Name Description Example
SUCCESS Action process success
FAILURE Action process failed

Issue Status: 1.4
ICS Australia
3.2.1 Routing Data Example
Please note only data is returned.
Domestic Label Example

Issue Status: 1.4
ICS Australia

Issue Status: 1.4
ICS Australia
3.2.2 Response Example (Routing)
Below is a complete HTTP Response (including headers)

HTTP/1.1 200 OK
Date: Wed, 08 Oct 2014 21:17:44 GMT
Server: Microsoft-IIS/6.0
X-TNT: 5FE2UAT
X-Powered-By: ASP.NET
X-AspNet-Version: 4.0.30319
Cache-Control: private
Content-Type: text/xml; charset=utf-8
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ProcessConsignmentRequestResponse xmlns="http://tempuri.org/">
<ProcessConsignmentRequestResult xmlns:a="http://schemas.datacontract.org/2004/07/"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:ConsignmentProcessResultList>
<a:ConsignmentProcessResult>
<a:ConsignmentActionList
xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<b:anyType i:type="a:RoutingResponse">
<a:BinNumber>30000</a:BinNumber>
<a:GatewayDepot>LV3</a:GatewayDepot>
<a:IsServiceSupported>true</a:IsServiceSupported>
<a:OnForwardingDepot>LV3</a:OnForwardingDepot>
<a:OriginDepot>SW2</a:OriginDepot>
<a:Postcode>3000</a:Postcode>
<a:Status>SUCCESS</a:Status>
<a:Suburb>MELBOURNE</a:Suburb>
<a:errors/>
</b:anyType>
</a:ConsignmentActionList>
<a:ConsignmentNumber i:nil="true"/>
</a:ConsignmentProcessResult>
</a:ConsignmentProcessResultList>
Issue Status: 1.4
ICS Australia
<a:Error>
<a:Code i:nil="true"/>
<a:Message i:nil="true"/>
</a:Error>
</ProcessConsignmentRequestResult>
</ProcessConsignmentRequestResponse>
</s:Body>
</s:Envelope>

Issue Status: 1.4
ICS Australia
3.3 Reprint Label Request

This function will return ConsignmentReprintResponse Object.
Consignment Reprint Request Object

This is the top level request object for ProcessConsignmentRequest method
Username String(20) Y The userid provided by CIT representative CIT00000000000001947
Password String(30) Y The password associated with the userid LetMeIn
ConsignmentNumber String(15) Y The consignment is submitted via this
service in last 40 days
LabelType Enum Print Layout Type Y Define what type of label layout to print.
Object

Issue Status: 1.4
ICS Australia
3.3.1 Reprint Label Request Example
POST http://localhost:56665/ConsignmentService.svc HTTP/1.1

Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "http://tempuri.org/IConsignmentService/ReprintLabelRequest"
Content-Length: 624
Host: localhost:56665
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConsignmentService">
<soapenv:Header/>
<soapenv:Body>
<tem:ReprintLabelRequest>

<tem:Request>
<con:UserName>xxxxx</con:UserName>
<con:Password>yyyyyyy</con:Password>
<con:ConsignmentNumber>YYY000001001</con:ConsignmentNumber>
<con:labelType>A</con:labelType>
</tem:Request>
</tem:ReprintLabelRequest>
</soapenv:Body>
</soapenv:Envelope>
3.4 Reprint Label Response

The method ReprintLabelRequest in Consignment Web Service returns ConsignmentReprintResponse
Object.
ConsignmentReprintResponse Object
ConsignmentNumber string
ReprintActionResult IActionResult Object
Error ErrorResponse Object Response status for the
main request

Issue Status: 1.4
ICS Australia
Status Enum of
IActionResult Object
LabelPDF Byte[] PDF data. Decode 20123
using Base64.
Status Enum of
Errors List of Error Response
Object

Issue Status: 1.4
ICS Australia
3.4.1 Response Example (Reprint)

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Encoding: gzip
Vary: Accept-Encoding
Server: Microsoft-IIS/8.0
X-SourceFiles: =?UTF-8?B?
RDpccHJvamVjdHNcVE5UT25saW5lXFZpcnR1YWxEaXJlY3Rvcmllc1xDb25zaWdubWVudFNlcn
ZpY2VcQ29uc2lnbm1lbnRTZXJ2aWNlXENvbnNpZ25tZW50U2VydmljZS5zdmM=?=
X-Powered-By: ASP.NET
Date: Thu, 04 Dec 2014 04:25:47 GMT
<s:Body>
<ReprintLabelRequestResponse xmlns="http://tempuri.org/">
<ReprintLabelRequestResult
xmlns:a="http://schemas.datacontract.org/2004/07/ConsignmentService"
<a:ConsignmentNumber>OBT000001001</a:ConsignmentNumber>
<a:ReprintActionResult i:type="a:CreateLabelResponse">
<a:LabelPDF>DQoNCjwhRE9DVFlQRSBodG1sIFBVQkxJQyAiLS8vVzNDLy9EVEQgWEhUTUw
gMS4wIFRyYW5zaXRpb25hbC8vRU4iICJodHRwOi8vd3d3LnczLm9yZy9UUi94aHRtbDEvRFRE
L3hodG1sMS10cmFuc2l0aW9uYWwuZHRkIj4NCjxodG1sIHhtbG5zPSJodHRwOi8vd3d3LnczLm
9yZy8xOTk5L3hodG1sIiA+DQo8L2JvZHk+DQo8L2h0bWw+DQoNCg==</a:LabelPDF>
<a:errors/>
</a:ReprintActionResult>
<a:Error>
<a:Code i:nil="true"/>
<a:Message i:nil="true"/>
</a:Error>
</ReprintLabelRequestResult>
</ReprintLabelRequestResponse>
</s:Body>
</s:Envelope>
Issue Status: 1.4
ICS Australia
3.5 Client side setting when using .net
A PDF Label may be in large size. So the default value of maxReceivedMessageSize is not enough in
the .net client application. The value should be increased.
Below is the recommend value of maxReceivedMessageSize for calling this service.
<binding maxReceivedMessageSize="2147483647" name= . . .
4 Error Handling
The response object contains two different types of error:
1. Schema validation error
2. Error returns from service process.
4.1 Schema Validation Error
4.1.1 Scenario
When input data fail to pass the Consignment Web service request schema, this kind of error will be
returned.
4.1.2 Schema Validation Error Example

The schema validation includes xml deserialization and schema definition validation.
Deserialization Error Example

<s:Body>
<s:Fault>
<faultcode
xmlns:a="http://schemas.microsoft.com/net/2005/12/windowscommunicationfoundation/dispatche
r">a:DeserializationFailed</faultcode>
<faultstring xml:lang="en-AU">The formatter threw an exception while trying to deserialize
the message: There was an error while trying to deserialize parameter
http://tempuri.org/:Request. The InnerException message was 'Invalid enum value '1233' cannot
be deserialized into type 'ConsignmentLibrary.SpecialIntructionTextType'. Ensure that the
necessary enum values are present and are marked with EnumMemberAttribute attribute if the
type has DataContractAttribute attribute.'. Please see InnerException for more
details.</faultstring>
<detail>
<ExceptionDetail xmlns="http://schemas.datacontract.org/2004/07/System.ServiceModel"
<HelpLink i:nil="true"/>
<InnerException>
Issue Status: 1.4
ICS Australia
<HelpLink i:nil="true"/>
<InnerException i:nil="true"/>
<Message>Invalid enum value '1233' cannot be deserialized into type
'ConsignmentLibrary.SpecialIntructionTextType'. Ensure that the necessary enum values are
present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute
attribute.</Message>
<StackTrace><![CDATA[at
System.Runtime.Serialization.EnumDataContract.ReadEnumValue(String value, Int32 index,
Int32 count)
at System.Runtime.Serialization.EnumDataContract.ReadEnumValue(XmlReaderDelegator
reader)
at System.Runtime.Serialization.EnumDataContract.ReadXmlValue(XmlReaderDelegator
xmlReader, XmlObj....
<Type>System.Runtime.Serialization.SerializationException</Type>
</InnerException>
<Message>The formatter threw an exception while trying to deserialize the message:
There was an error while trying to deserialize parameter http://tempuri.org/:Request. The
InnerException message was 'Invalid enum value '1233' cannot be deserialized into type
'ConsignmentLibrary.SpecialIntructionTextType'. Ensure that the necessary enum values are
present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute
attribute.'. Please see InnerException for more details.</Message>
<StackTrace><![CDATA[at
System.ServiceModel.Dispatcher.DataContractSerializerOperationFormatter.DeserializeParamete
rPart(XmlDictionaryReader reader, PartInfo part, Boolean isRequest)
…………………
at System.ServiceModel.Dispatcher.MessageRpc.Process(Boolean
isOperationContextSet)]]></StackTrace>
<Type>System.ServiceModel.Dispatcher.NetDispatcherFaultException</Type>
</ExceptionDetail>
</detail>
</s:Fault>
</s:Body>
</s:Envelope>

Issue Status: 1.4
ICS Australia
Schema definition Validation Error Example
<s:Body>
<s:Fault>
<faultcode>s:Client</faultcode>
<faultstring xml:lang="en-AU">The creator of this fault did not specify a
Reason.</faultstring>
<detail>
<ValidationFault
xmlns="http://www.microsoft.com/practices/EnterpriseLibrary/2007/01/wcf/validation"
<Details
xmlns:a="http://schemas.datacontract.org/2004/07/Microsoft.Practices.EnterpriseLibrary.Validatio
n.Integration.WCF">
<a:ValidationDetail>
<a:Key>consignmentNumber</a:Key>
<a:Message>consignmentNumber must be between 0 and 15
characters.</a:Message>
<a:Tag>Request</a:Tag>
</a:ValidationDetail>
</Details>
</ValidationFault>
</detail>
</s:Fault>
</s:Body>
</s:Envelope>
4.2 Service Process Error
4.2.1 Possible Error Codes

Errors collection object return by the service process.
Each Errors object contains an error code and error description.
Error Code Error Message Description

001 Internal Error Internal service error not identified by
other error codes.
002 ConsignmentProcess Element is not Mandatory main element
provided “ConsignmentProcess” is not provided
003 User Authentication Failed User Authentication Failed
004 Consignment is not found Consignment not found for the
Issue Status: 1.4
ICS Australia
consignment provided in reprint request.

005 Consignment yyyyy is not authorised to be Consignment is not created by the user
reprinted by user xxxx provided in the reprint request.
100 Mandatory Elements XXXX are not Mandatory elements in consignment

provided. object and sub objects are not provided.
(Sequence value must start from 1)
201 Authenticated failed for Sender Code Username is not set up with the sender
code
202 Paying account is not valid TNT account. Account is not established in TNT
203 Consignment Number is not valid to Consignment number must be 3+9 or 9
generate labels to call GETLABLE action
204 Total items are more than 999 of this Total items of the consignment are more
consignment than 999
205 Collection, Delivery, Third party State is not Third party validate only when payer is
valid “T”
206 Consignment Date is not valid Consignment date is not in ddMMyyyy
format with correct value.
207 Consignment Date is not in the defined Consignment Date must be in TNT
range which must be no more than X day in allowed range.
the future or older than Y days in the past.
208 External Warranty Value is greater than The external warranty value is greater
maximum limit of $$$. than maximum value
209 Consignment keep in store until dow text
must be one of “MON, TUE,WED,THU,FRI”
description
210 Freight Ready Time/PremisClose Time must Time should be in HHMM format
be in HHMM format.
211 Return Authority Number needs to be in When any of Additional service 1 -5 is
Customer Consignment Reference element RET, Return Authority Number should
when any Additional service is RET be provided in the Customer
Consignment Reference element.
212 Suburb: xxxx Postcode: yyyy is invalid The suburb, postcode combination is
not valid
300 Error occurs in generating label There is an error when generate byte
data of the label.

Issue Status: 1.4
ICS Australia
4.2.2 Error Response Example
<s:Body>
<ProcessConsignmentRequestResponse xmlns="http://tempuri.org/">
<ProcessConsignmentRequestResult xmlns:a="http://schemas.datacontract.org/2004/07/"
<a:ConsignmentProcessResultList/>
<a:Error>
<a:Code>003</a:Code>
<a:Message>User Authentication Failed.</a:Message>
</a:Error>
</ProcessConsignmentRequestResult>
</ProcessConsignmentRequestResponse>
</s:Body>
</s:Envelope>

Issue Status: 1.4
ICS Australia
5 Label Types
5.1 Label Type A – Plain paper

One A6 address label per packages printed on plain A4 paper, and a single A4 consignment note.
This is used for customers printing to plain A4 paper. The address label/s will have to be affixed to
each package, and the consignment note is used as a proof of collection and stays with the
customer.
Please note that regardless of how many packages / labels are printed, only the first consignment
note is printed; the consignment portion of the second and subsequent pages will be blank.

Issue Status: 1.4
ICS Australia
5.2 Label Type B – eCon Paper Stock

This is printed on TNT supplied eCon stock.
Two A6 address labels on the top half of the paper stock and the contents of the eCon
consignment note.
Please note that the eCon paperwork has the consignment layout pre-printed. This version ONLY
prints the label and content of the consignment note. The consignment note is used as a proof of
collection and stays with the customer.
Please note that regardless of how many packages / labels are printed only the first consignment
note is printed; the consignment portion of the second and subsequent pages will be blank.

Issue Status: 1.4
ICS Australia
5.3 Label Type C – Thermal Label only

This label type prints to TNT supplied address labels (A6) only, no consignment notes are
printed. This is meant for high volume customers who produce will produce a collection
paper manifest (x2) for the driver to sign.

Issue Status: 1.4

ConsignmentService - Specification 1.42

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ConsignmentService - Specification 1.42

Uploaded by

Copyright:

Available Formats

ICS Australia

Consignment Web Service Specification

Title: Consignment Service Specification Page 1 of 44

Title: Consignment Service Specification Page 2 of 44

1.1 Service Actions

This service provides three possible actions:

Dynamic Web Routing

Title: Consignment Service Specification Page 3 of 44

1.2 Supported TNT Express Services

73 Overnight PAYU Satchel

712* 9:00 Express

EX10* 10:00 Express

EX12* 12:00 Express

718 Fashion Express

701 National Sameday

717 /B* Premium / Sensitive Express

o Abbreviations ie Mt instead of Mount, Crk instead of Creek etc…

o Incorrect postcode and suburb combinations ie Sydney NSW 2010

Title: Consignment Service Specification Page 4 of 44

2 Consignment Web Service

2.1 System Overview

Figure 1. Physical View

Figure 2. Logical View

Test Web Service WSDL Location

Production Web Service WSDL Location

Title: Consignment Service Specification Page 5 of 44

The password will be your TNT online password.

The following items are linked to your UserID:

Title: Consignment Service Specification Page 6 of 44

3 API Functions and Parameters

The function ProcessConsignmentRequest takes ConsignmentRequest object as input parameter.

3.1 Process Consignment Request

Consignment Request Object

Title: Consignment Service Specification Page 7 of 44

Title: Consignment Service Specification Page 8 of 44

shipment is to be collected / picked up

CancelIndicator Enum of Indicator Type Y Refer to Indicator Type object Y/N

Title: Consignment Service Specification Page 9 of 44

ExtendedWarrantyValue Int (8) N Enter amount of coverage required. Max

Title: Consignment Service Specification Page 10 of 44

(please note only GetRoutingData and

Title: Consignment Service Specification Page 11 of 44

Third Party Object

Consignment Special Instruction Object

Package Line Object

ItemLength Decimal (7.3) Y Length of largest dimension Item

Dangerous Goods Object - Optional

Title: Consignment Service Specification Page 13 of 44

Item Identifiers Object

ItemReference String(30) N Item reference for corresponding item

Customer Reference Object

Title: Consignment Service Specification Page 14 of 44

Alert Address Object

Consignment Keep In Store Object

KeepUntilDow2 String(3) N “Mon”, “Tue”, “Wed”, “Thu”, “Fri”

KeepUntilDow3 String(3) N “Mon”, “Tue”, “Wed”, “Thu”, “Fri”

KeepUntilDow4 String(3) N “Mon”, “Tue”, “Wed”, “Thu”, “Fri”

KeepUntilDow5 String(3) N “Mon”, “Tue”, “Wed”, “Thu”, “Fri”

Consignment Pickup Object

Title: Consignment Service Specification Page 15 of 44

Consignment Special Reference Object

Consignment Action Type Object

Extra Option Object