Use the tracking API to retrieve tracking information for a shipment. Individual tracking is limited to 1 call per second. For occasional use, we provide a tracking API to return all events for a single shipment. To retrieve all tracking events, call the service with the type = "new". This is the most efficient and fastest way to stay up-to-date on all tracking events for your account.
Sample tracking request, for a single parcel. trackingrequest.xml
<xml> <tracking tracknbr="123" /> </xml>
Sample tracking request, download all "new" events, since the last API call. This is our recommended approach for getting tracking information. trackingrequestnew.xml
<xml> <tracking type="new" account="ABC" /> </xml>
XSD / Schema - tracking.xsd Download tracking.xsd
<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="xml">
<xs:complexType>
<xs:sequence>
<xs:element name="tracking" minOccurs="1" maxOccurs="1">
<xs:complexType>
<xs:attribute name="tracknbr">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="type">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="6" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="account">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="30" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="limit">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="6" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:sequence>
<xs:element name="error" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="code" use="required" type="xs:string" />
<xs:attribute name="description" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="500" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="context">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:sequence>
<xs:anyAttribute />
</xs:complexType>
</xs:element>
</xs:schema>Specifies the tracking number of a specific number to track.
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| tracknbr | Tracking number of the parcel to be tracked. | Text (50) | Optional | 1234567890 |
| type | Specify "new" to get all new tracking events received since the last tracking event. | Text (6) | Optional | new |
| account | Account code, optional except for customers supporting multiple accounts, when using the "new" tracking type attribute. | Text (30) | Optional | ABC |
| limit | When downloading all new tracking events, you may wish to limit results. If you specify 1000, you will get back the oldest 1000 events since you last downloaded new events. You can then call it again to get additional newer events. The default and maximum limit is 10000 events. | Text (6) | Optional | 10000 |
Sample response for a single parcel. All events for this parcel are returned. NOTE: the most recent event appears first trackingresponse.xml
<xml>
<trackingresponse tracknbr="1234567890" mawb="123-12345678">
<trackingevent code="FD01" description="Parcel Delivered" eventdate="2020-04-06T10:20" city="Brisbane" country="AU" />
<trackingevent code="DC01" description="Cleared Customs" eventdate="2020-04-05T11:28" city="Brisbane" country="AU" />
<trackingevent code="DA01" description="Shipment arrived in Destination Country" eventdate="2020-04-02T8:28" city="Singapore" country="SN" />
<trackingevent code="CI02" description="Customer Information Manifested" eventdate="2020-04-01T19:28" city="London" country="GB" />
</trackingresponse>
</xml>Sample response for "new" tracking events. Multiple parcels are returned, and likely multiple events for each parcel. trackingresponsenew.xml
<xml>
<trackingresponse tracknbr="123" mawb="123-12345678">
<trackingevent code="FD01" description="Parcel Delivered" eventdate="2020-04-06T10:20" city="Brisbane" country="AU" />
</trackingresponse>
<trackingresponse tracknbr="234" mawb="234-2345678">
<trackingevent code="FD01" description="Parcel Delivered" eventdate="2020-04-06T10:20" city="Brisbane" country="AU" />
<trackingevent code="DC01" description="Cleared Customs" eventdate="2020-04-05T11:28" city="Brisbane" country="AU" />
</trackingresponse>
</xml>XSD / Schema - trackingresponse.xsd Download trackingresponse.xsd
<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="xml">
<xs:complexType>
<xs:sequence>
<xs:element name="trackingresponse" minOccurs="1" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element name="trackingevent" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="code" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="AD01">
<!--Departure delay-->
</xs:enumeration>
<xs:enumeration value="AD02">
<!--Airline transit delay-->
</xs:enumeration>
<xs:enumeration value="AD03">
<!--Airline departure delay due to extreme weather at destination-->
</xs:enumeration>
<xs:enumeration value="CI02">
<!--Customer label information received-->
</xs:enumeration>
<xs:enumeration value="CI03">
<!--Shipment cancelled by the customer-->
</xs:enumeration>
<xs:enumeration value="CI06">
<!--Parcel delivery information received-->
</xs:enumeration>
<xs:enumeration value="CI07">
<!--We haven’t received your parcel yet. Please check with the retailer.-->
</xs:enumeration>
<xs:enumeration value="DA01">
<!--Parcel arrived in destination country-->
</xs:enumeration>
<xs:enumeration value="DA02">
<!--Parcel arrived in trans-shipment country.-->
</xs:enumeration>
<xs:enumeration value="DA05">
<!--Collected from the airline for processing-->
</xs:enumeration>
<xs:enumeration value="DA06">
<!--Parcel arrived in transit port-->
</xs:enumeration>
<xs:enumeration value="DA11">
<!--Your parcel did not physically arrive, only tracking information was provided-->
</xs:enumeration>
<xs:enumeration value="DC01">
<!--Customs cleared-->
</xs:enumeration>
<xs:enumeration value="DC03">
<!--Parcel received at clearance facility-->
</xs:enumeration>
<xs:enumeration value="DC11">
<!--Customs clearance delay-->
</xs:enumeration>
<xs:enumeration value="DC14">
<!--Your parcel may be delayed, due to missing mandatory entry data-->
</xs:enumeration>
<xs:enumeration value="DC32">
<!--Australian Border Force - Held for inspection-->
</xs:enumeration>
<xs:enumeration value="DE03">
<!--Parcel damaged in transit and undeliverable-->
</xs:enumeration>
<xs:enumeration value="DE20">
<!--Parcel returned and re-exported to sender-->
</xs:enumeration>
<xs:enumeration value="DE21">
<!--Parcel returned to retailer-->
</xs:enumeration>
<xs:enumeration value="DH01">
<!--Parcel processed by clearance facility-->
</xs:enumeration>
<xs:enumeration value="DH02">
<!--Handed over for trans-shipment-->
</xs:enumeration>
<xs:enumeration value="DT01">
<!--Domestic linehaul departed-->
</xs:enumeration>
<xs:enumeration value="DT02">
<!--Domestic linehaul arrival-->
</xs:enumeration>
<xs:enumeration value="DT03">
<!--Parcel in transit for processing-->
</xs:enumeration>
<xs:enumeration value="DT04">
<!--Parcel in transit for processing-->
</xs:enumeration>
<xs:enumeration value="DT05">
<!--Parcel arrived at processing facility-->
</xs:enumeration>
<xs:enumeration value="E2E5">
<!--For testing purposes only-->
</xs:enumeration>
<xs:enumeration value="FD01">
<!--Parcel delivered-->
</xs:enumeration>
<xs:enumeration value="FD02">
<!--Parcel delivered - authority to leave-->
</xs:enumeration>
<xs:enumeration value="FD03">
<!--Parcel delivered to neighbouring property-->
</xs:enumeration>
<xs:enumeration value="FD10">
<!--Parcel unsafe to leave at address-->
</xs:enumeration>
<xs:enumeration value="FD11">
<!--Parcel delivered-->
</xs:enumeration>
<xs:enumeration value="FD12">
<!--Parcel unsafe to leave at address-->
</xs:enumeration>
<xs:enumeration value="FD13">
<!--Parcel unsafe to leave at address-->
</xs:enumeration>
<xs:enumeration value="FD21">
<!--Parcel available for collection-->
</xs:enumeration>
<xs:enumeration value="FD31">
<!--Parcel delivered - collected from pick up location-->
</xs:enumeration>
<xs:enumeration value="FE01">
<!--Undeliverable, unsafe to leave at address-->
</xs:enumeration>
<xs:enumeration value="FE03">
<!--Undeliverable, address details incorrect-->
</xs:enumeration>
<xs:enumeration value="FE04">
<!--Undeliverable, refused delivery at address-->
</xs:enumeration>
<xs:enumeration value="FE05">
<!--Held in depot, pending further instructions-->
</xs:enumeration>
<xs:enumeration value="FE06">
<!--Undeliverable, address details incorrect-->
</xs:enumeration>
<xs:enumeration value="FE07">
<!--Delivery under investigation with final mile carrier-->
</xs:enumeration>
<xs:enumeration value="FE08">
<!--Parcel redirected to new address-->
</xs:enumeration>
<xs:enumeration value="FE09">
<!--Item misrouted or redirected-->
</xs:enumeration>
<xs:enumeration value="FE10">
<!--Parcel returned to the final mile carrier facility-->
</xs:enumeration>
<xs:enumeration value="FE11">
<!--Parcel on route to returns facility-->
</xs:enumeration>
<xs:enumeration value="FP01">
<!--Parcel processed for final mile carrier delivery-->
</xs:enumeration>
<xs:enumeration value="FP03">
<!--Parcel in transit with the final mile carrier-->
</xs:enumeration>
<xs:enumeration value="FP05">
<!--Parcel out for final mile carrier delivery-->
</xs:enumeration>
<xs:enumeration value="FP07">
<!--Parcel received by final mile carrier-->
</xs:enumeration>
<xs:enumeration value="FP09">
<!--Your parcel has been handed over into our regional delivery network-->
</xs:enumeration>
<xs:enumeration value="FP10">
<!--Parcel delivery delay-->
</xs:enumeration>
<xs:enumeration value="FP11">
<!--Delivery delay anticipated due to extreme weather-->
</xs:enumeration>
<xs:enumeration value="INT-0003">
<!--Arrived at facility-->
</xs:enumeration>
<xs:enumeration value="INT-0008">
<!--Cleared and awaiting international departure-->
</xs:enumeration>
<xs:enumeration value="INT-0030">
<!--International arrival - awaiting clearance-->
</xs:enumeration>
<xs:enumeration value="INT-0031">
<!--Item received into Customs for clearance-->
</xs:enumeration>
<xs:enumeration value="INT-0032">
<!--Arrived at local facility for delivery-->
</xs:enumeration>
<xs:enumeration value="INT-0035">
<!--Received by postal carrier for delivery-->
</xs:enumeration>
<xs:enumeration value="INT-0071">
<!--Arrived at facility-->
</xs:enumeration>
<xs:enumeration value="INT-0074">
<!--Onboard for delivery-->
</xs:enumeration>
<xs:enumeration value="INT-2031">
<!--Scheduled for despatch-->
</xs:enumeration>
<xs:enumeration value="INT-2144">
<!--Item lodged-->
</xs:enumeration>
<xs:enumeration value="INT-2164">
<!--Landed in Destination Country-->
</xs:enumeration>
<xs:enumeration value="INT-2165">
<!--Arrived at postal carrier's facility in USA-->
</xs:enumeration>
<xs:enumeration value="INT-2170">
<!--Item has been handed over to the air carrier-->
</xs:enumeration>
<xs:enumeration value="INT-2171">
<!--Booked for flight-->
</xs:enumeration>
<xs:enumeration value="INT-2177">
<!--Flight departed-->
</xs:enumeration>
<xs:enumeration value="INT-2180">
<!--Flight landed-->
</xs:enumeration>
<xs:enumeration value="INT-2185">
<!--Item handed over to the local postal authority-->
</xs:enumeration>
<xs:enumeration value="INT-2187">
<!--Arrived at facility-->
</xs:enumeration>
<xs:enumeration value="OA01">
<!--Checked in at origin hub-->
</xs:enumeration>
<xs:enumeration value="OA02">
<!--Parcel not received at origin facility-->
</xs:enumeration>
<xs:enumeration value="OA03">
<!--Parcel received in processing facility-->
</xs:enumeration>
<xs:enumeration value="OE01">
<!--Parcel rejected at origin facility-->
</xs:enumeration>
<xs:enumeration value="OP01">
<!--Parcel processed at origin facility-->
</xs:enumeration>
<xs:enumeration value="OP03">
<!--Parcel processed at origin facility-->
</xs:enumeration>
<xs:enumeration value="OP07">
<!--Parcel received and sorted-->
</xs:enumeration>
<xs:enumeration value="OP08">
<!--Parcel received in transit facility-->
</xs:enumeration>
<xs:enumeration value="OP09">
<!--Parcel held by origin border security-->
</xs:enumeration>
<xs:enumeration value="OU01">
<!--Parcel departed origin country-->
</xs:enumeration>
<xs:enumeration value="OU02">
<!--Parcel departed trans-shipment country-->
</xs:enumeration>
<xs:enumeration value="OU03">
<!--Parcel departed transit port-->
</xs:enumeration>
<xs:enumeration value="SF01">
<!--Qantas Freight system failure – significant delays expected-->
</xs:enumeration>
<xs:enumeration value="SF02">
<!--Airline ground handling delay-->
</xs:enumeration>
<xs:enumeration value="WE01">
<!--Parcel lost in transit-->
</xs:enumeration>
<xs:enumeration value="WE02">
<!--Delivery data is incomplete-->
</xs:enumeration>
<xs:enumeration value="WR01">
<!--Parcel sent to returns facility-->
</xs:enumeration>
<xs:enumeration value="WR02">
<!--Parcel sent to returns facility-->
</xs:enumeration>
<xs:enumeration value="WR10">
<!--Parcel received at returns facility-->
</xs:enumeration>
<xs:enumeration value="WR14">
<!--Parcel returned to sender-->
</xs:enumeration>
<xs:enumeration value="WR17">
<!--Parcel returned - By the recipient-->
</xs:enumeration>
<xs:enumeration value="WR19">
<!--Returned to sender - Overweight/Oversize parcel-->
</xs:enumeration>
<xs:enumeration value="WR21">
<!--Parcel reshipped to receiver from returns facility-->
</xs:enumeration>
<xs:maxLength value="5" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="description" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="150" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="eventdate" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="16" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="city">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="150" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="country">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="2" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="error" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="code" use="required" type="xs:string" />
<xs:attribute name="description" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="500" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="context">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
<xs:attribute name="tracknbr" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="mawb" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="25" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:sequence>
<xs:element name="error" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="code" use="required" type="xs:string" />
<xs:attribute name="description" use="required">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="500" />
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="context">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="50" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:sequence>
<xs:anyAttribute />
</xs:complexType>
</xs:element>
</xs:schema>Tracking data for the specified tracking request.
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| tracknbr | Tracking number for the shipment being tracked. | Text (50) | 1234567890 | |
| mawb | MAWB - when available | Text (25) | 123-12345678 |
A repeating group of tracking events. The most recent will appear first.
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| code | Tracking event code See reference values for "trackingeventcodes" | Text (5) | FD01 | |
| description | Description of the event | Text (150) | Shipment Delivered | |
| eventdate | Date and Time of the Tracking Event in the local time of the event. | datetime | 2020-04-01T10:28 | |
| city | City, where the tracking event occurred. | Text (150) | Optional | London |
| country | Country code (ISO 3166) where the tracking event occurred. | Text (2) | Optional | GB |
Errors are specified if there's a technical error or the tracking number cannot be found.
| Name | Description | Type | Optional | Sample Value |
|---|---|---|---|---|
| code | Code value of the error | int | 100 | |
| description | Text description of the error message | Text (500) | Invalid XML | |
| context | Error context information | Text (50) | Optional | Error on line 1 |