NAV

Getting Started

Introduction

This document is a quick start guide on how to integrate with Temando’s Soap services.

Using these services you can:

  • Get quotes for shipping a package
  • Book a shipment and print a shipping label
  • Create manifest documentation
  • Track a shipment

To use this document, you should have a basic familiarity with software development and web services.

This document is structured like a cook book. We present common api methods and use cases which can be accessed through the navigation menu.

For more details, please refer to the Developer Guide.

If you have any questions or need help, please feel free to drop us a line at itsupport@temando.com.

Processes Overview

The Temando fulfilment process consists of several interconnected steps that need to occur in sequence. A typical fulfilment process consists of the following steps: get quotes, make a booking, get manifest, confirm manifest, then track the booked consignment.

Combined, these steps will enable an integration to provide Temando powered fulfilment services that can offer your customers shipment quotes, bookings, as well as transfer these bookings to the chosen carrier (manifest). Temando will also enable the tracking of these packages by making accessible a consignment’s full tracking history.

From the customer perspective, the fulfilment process enables the following use case in a shopping cart scenario:

  • Customer selects an item from your store.
  • Customer obtains a shipment quote by entering details about their desired delivery location, for example: suburb/city and post code.
  • Customer presses “Get a quote” button, which will send a getQuotes request to Temando.
  • Temando returns a list of possible quotes. This list depends on the number of carriers that were configured for the shopping cart client.
  • Customer accepts the quote with a carrier.
  • Customer pays for the order, which will send a makeBooking request to Temando.
  • Temando sends a request to the selected carrier, which will start the process of shipping the product.
  • Customer can track the order after they have been shipped, either through Temando tracking portal or through a portal built for your store.


From the developer perspective, the fulfilment process enables the following use case:

  • Your system can invoke Temando’s getQuotes to check what quotes are available based on particular request parameters.
  • Your system can invoke makeBooking to book in a request with a carrier using one of the available quotes.
  • If your Temando account has manifesting set up with the carrier, then your system can run getManifest to verify all booked shipments are ready for a particular date. This step is optional.
  • Your system can invoke confirmManifest to confirm that all are ready.
  • Your system can invoke getRequest to track the items after they have been shipped.

Below are detailed explanation of each of these steps. Note that examples of the actual elements and their values are available within the operation descriptions.

Step 1 - Get Quotes

The first step is to identify what quotes are available. To achieve this a call must be made to the getQuotes operation and provide the particulars of the request that needs to be sent. These particulars are grouped as follows:

Anythings Details about the items to be included in the consignment, including packaging type, dimensions, weights, and articles contained inside the packaging.
Anywhere Details about where the items are being sent from/to.
Anytime Details about when the items are ready for pickup.
General Other general details about the item/s are being sent (eg. goods value).

Once this operation has been processed, the response will contain a list of available quotes. For each quote returned, the following information is provided:

Quote General information for the quote, such as price, delivery time, etc.
Adjustments List of adjustments that will be applied based on the payment method used at the booking stage.
Inclusions If there are any inclusions associated with the quote (eg. tracking available, instant booking, etc). These incur no extra expense as they are included in the quote price.
Extras If there are any extras available for the quote (eg. insurance, etc). These are an extra expense and will be added to the quote price if selected in the booking step.
Carrier Information about the carrier service.

Step 2 - Make a Booking

Once the available quotes have been provided and the required quote identified, a booking must be made to register the request and the identified quote. To achieve this a call must be made to the makeBooking operation. The information required for this call is grouped as follows:

Anythings, Anywhere, Anytime, General This is the exact same details as what was provided in the Get Quotes call in the previous step.
Origin The specific details about where an item is being sent from or the originating address.
Destination The specific details about where an item is being sent to or the final destination address.
Quote This will include:
  • The specific details about the accepted quote.
  • The extras to be included with the quote (eg. insurance, etc).
These must match exactly with the details provided in the response to the Get Quotes call in the previous step.
Payment The payment details for the payment of the quote.
Instructions Delivery instructions that should be communicated to the driver.
Comments General comments relating to the request.
PromotionCode Temando code used for promotional partners.

Once this operation has been processed, the response will contain the following information:

Request Id The unique Temando id for this booking.
Booking Number The carrier’s booking number for the request. This is only provided if it was detailed as an inclusion for the quote that was accepted from step 1.
Consignment Details This will include the consignment number, consignment document and document type. This is only provided if it was detailed as an inclusion for the quote that was accepted from step 1.

Step 3 - Get Manifest

Manifesting is the process of the merchant confirming that a collection of shipments are ready for pick up by a carrier. This is only available if you have registered your pickup location for manifesting. For further information, please see our section on What is Manifesting.

Before confirming a manifest it is likely you may want to verify that all shipments which have been booked are actually ready for pickup. The getManifest operation can be called with the request type Awaiting Confirmation to get a list of items that would be confirmed by a confirmManifest call.

Step 4 - Confirm Manifest

Items which are ready for pickup can be confirmed by a call to the confirmManifest operation. Doing so will cause Temando to ask the relevant carrier to dispatch to your location for a pick up. Further, shipments can no longer be cancelled via a Temando API once this has been confirmed, as the carrier has been instructed to pickup the items. Cancellations must be negotiated with the carrier after a manifest has been confirmed. After a manifest is confirmed, it can be retrieved using the getManifest operation with the request type Confirmed.

Step 5 - Tracking

Tracking the status of a shipment can be performed by making a call to the getRequest operation. This will return the request and associated details based on the supplied request id.

The getRequest operation can also be used to retrieve a label in case it wasn’t captured in the makeBooking response.

Soap Wsdl

To invoke the Soap services, you need to load the Wsdl file into your client application.

Temando provides the Soap services on 2 separate environments. You should test with the demo environment during your application development / testing phases. After you’ve completed testing, your application needs to be updated to point to Temando’s production environment.

The Soap services locations are below:

Environment Wsdl location
Demo http://api-demo.temando.com/schema/2009_06/server.wsdl
Production https://api.temando.com/schema/2009_06/server.wsdl

Demo Wsdl and production Wsdl are almost the same, except for namespaces (one points to api-demo.temando.com and the other points to api.temando.com)

API Credentials

To make calls to Temando API, you must have a client account with Temando.

Each web service request needs to include the account’s user name and password in the request header (see API Overview for an example of a Soap request message).

For the demo environment, the below accounts could be used:

Client Id User name Password Use
20420 TEMANDOTEST temandopass1 Test account with no insurance or manifesting
59010 TEMANDOTEST_INSURANCE temandopass1 Test account with insurance
59012 TEMANDOTEST_MANIFESTING temandopass1 Test account with manifesting
59014 TEMANDOTEST_MANIFESTING_INSURANCE temandopass1 Test account with manifesting and insurance

For production environment, please see the FAQ

Package Optimisation

Packaging optimisation is a series of calculations in the Temando system which allows a number of smaller individual items to be accumulated into one larger package based on calculated volumes and weights of the items and the available package sizes.

Packaging options (larger boxes, containers etc.) must first be set up in the system before calling the capability via the getQuotes or makeBooking calls.

The logic takes into consideration both the spatial & volumetric measurements. Dimensions of the pre-configured packaging include actual (outside physical dimensions) and available (inside physical dimension). The actual are the dimensions used for calculating freight cost and available are used to identify available space for packing. Packaging order (prioritisation) is based off the size of the packaging itself, that is, the smallest packaging will be used first and then incrementally as the packaging sizes increase. This can however be overridden with a priority assignment to the packaging, to enable larger packaging to be used before smaller ones.

Defining Packages

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://api-demo.temando.com/schema/2009_06/server.xsd">
    <soapenv:Header>
        <Security>
            <UsernameToken>
                <Username>username</Username>
                <Password>password</Password>
            </UsernameToken>
        </Security>
    </soapenv:Header>
    <soapenv:Body>
        <ser:createPackaging>
            <!--You may enter the following items in any order-->
            <clientId></clientId>
            <packaging>
                <!--You may enter the following items in any order-->
                <description>BigBox1</description>
                <class>General Goods</class>
                <subclass>Household Goods</subclass>
                <mode>Less than load</mode>
                <packaging>Box</packaging>
                <distanceMeasurementType>Centimetres</distanceMeasurementType>
                <weightMeasurementType>Kilograms</weightMeasurementType>
                <comparisonLength>49</comparisonLength>
                <comparisonWidth>49</comparisonWidth>
                <comparisonHeight>49</comparisonHeight>
                <comparisonWeight></comparisonWeight>
                <actualLength>50</actualLength>
                <actualWidth>50</actualWidth>
                <actualHeight>50</actualHeight>
                <actualWeight>9</actualWeight>
                <priority>1</priority>
            </packaging>
        </ser:createPackaging>
    </soapenv:Body>
</soapenv:Envelope>

Optimisation processing requires that larger packages be defined in the Temando system for reference by the API. The pre-defined packages are created using the createPackaging XML call as shown on the right hand side:

Using Packaging Optimisation

<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"
xmlns:enc="http://www.w3.org/2003/05/soap-encoding"
xmlns:ns1="http://api-demo.temando.com/schema/2009_06/server.xsd"
xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/">
    <env:Header>
        <ns2:Security>
            <ns2:UsernameToken>
                <ns2:Username>username</ns2:Username>
                <ns2:Password>password</ns2:Password>
            </ns2:UsernameToken>
        </ns2:Security>
    </env:Header>
    <env:Body>
        <ns1:getQuotes>
            <anythings>
                <anything>
                    <class>General Goods</class>
                    <subclass>Household Goods</subclass>
                    <mode>Less Than Load</mode>
                    <packaging>Box</packaging>
                    <distanceMeasurementType>Centimetres</distanceMeasurementType>
                    <weightMeasurementType>Grams</weightMeasurementType>
                    <length>50</length>
                    <width>10</width>
                    <height>10</height>
                    <weight>10</weight>
                    <quantity>1</quantity>
                    <packagingOptimisation>Y</packagingOptimisation>
                </anything>
                <anything>
                    <class>General Goods</class>
                    <subclass>Household Goods</subclass>
                    <mode>Less Than Load</mode>
                    <packaging>Box</packaging>
                    <distanceMeasurementType>Centimetres</distanceMeasurementType>
                    <weightMeasurementType>Grams</weightMeasurementType>
                    <length>50</length>
                    <width>10</width>
                    <height>10</height>
                    <weight>10</weight>
                    <quantity>1</quantity>
                    <packagingOptimisation>Y</packagingOptimisation>
                </anything>
            </anythings>
            <origin></origin>
            <anywhere>
                <itemNature>Domestic</itemNature>
                <itemMethod>Door to Door</itemMethod>
                <originCountry>AU</originCountry>
                <originCode>4000</originCode>
                <originSuburb>BRISBANE</originSuburb>
                <destinationCountry>AU</destinationCountry>
                <destinationCode>4000</destinationCode>
                <destinationSuburb>BRISBANE</destinationSuburb>
                <destinationIs>Residence</destinationIs>
                <destinationBusHeavyLift>N</destinationBusHeavyLift>
                <originIs>Business</originIs>
                <originBusHeavyLift>N</originBusHeavyLift>
            </anywhere>
            <anytime>
                <readyDate>2016-01-04</readyDate>
                <readyTime>PM</readyTime>
            </anytime>
            <general/>
        </ns1:getQuotes>
    </env:Body>
</env:Envelope>

Use of packaging optimisation is achieved by setting the packagingOptimisation XML tag to Y in the getQuotes or makeBooking call. Items <anything> flagged for packagingOptimisation will proceed through the calculations to achieve the best packaging result. An example of the call to the Temando system is shown on the right hand side:

Multiple items <anything> in the getQuotes or makeBooking call can be set individually to have packaging optimisation or not. Setting <packagingOptimisation>Y</packagingOptimisation> results in the <anything> being included in calculations while setting <packagingOptimisation>N</packagingOptimisation> excludes the <anything> from optimisation.

Results from enabling packagingOptimisation

<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:ns1="http://api-demo.temando.com/schema/2009_06/server.xsd">
    <env:Body>
        <ns1:getQuotesResponse>
            <anythings>
                <anything>
                    <class>General Goods</class>
                    <subclass>Household Goods</subclass>
                    <mode>Less than load</mode>
                    <packaging>Box</packaging>
                    <qualifierFreightGeneralFragile>N</qualifierFreightGeneralFragile>
                    <distanceMeasurementType>Centimetres</distanceMeasurementType>
                    <weightMeasurementType>Kilograms</weightMeasurementType>
                    <length>48</length>
                    <width>48</width>
                    <height>48</height>
                    <weight>0</weight>
                    <quantity>1</quantity>
                    <packagingDescription>BigBox1</packagingDescription>
                </anything>
            </anythings>
            <quotes>
                <quote>
                    <generated>Automatically</generated>
                    <accepted>N</accepted>
                    <totalPrice>14.31</totalPrice>
                    <basePrice>13</basePrice>
                    <tax>1.31</tax>
                    <currency>AUD</currency>
                    <deliveryMethod>Road Service</deliveryMethod>
                    <usingGeneralRail>N</usingGeneralRail>
                    <usingGeneralRoad>N</usingGeneralRoad>
                    <usingGeneralSea>N</usingGeneralSea>
                    <usingExpressAir>N</usingExpressAir>
                    <usingExpressRoad>Y</usingExpressRoad>
                    <etaFrom>1</etaFrom>
                    <etaTo>2</etaTo>
                    <guaranteedEta>N</guaranteedEta>
                    <adjustments>
                        <adjustment>
                            <description>Credit Card Payment Adjustment</description>
                            <amount>0.26</amount>
                            <tax>0.03</tax>
                        </adjustment>
                        <adjustment>
                            <description>Credit Payment Adjustment</description>
                            <amount>-0.26</amount>
                            <tax>-0.03</tax>
                        </adjustment>
                    </adjustments>
                    <inclusions/>
                    <extras/>
                    <carrier>
                        <id>60052</id>
                        <companyName>Couriers Please Metro Parcel</companyName>
                        <companyContact>Admin</companyContact>
                        <streetAddress>Unit 4, 29-33 Carter St</streetAddress>
                        <streetSuburb>Homebush</streetSuburb>
                        <streetCity>Sydney</streetCity>
                        <streetState/>
                        <streetCode>2140</streetCode>
                        <streetCountry>AU</streetCountry>
                        <postalAddress>Unit 4, 29-33 Carter St</postalAddress>
                        <postalSuburb>Homebush</postalSuburb>
                        <postalCity>Sydney</postalCity>
                        <postalState/>
                        <postalCode>2140</postalCode>
                        <postalCountry>AU</postalCountry>
                        <phone1>1300 163 244</phone1>
                        <email>couriersplease3@temando.com</email>
                        <website>http://www.couriersplease.com.au/ezytrak</website>
                    </carrier>
                </quote>
            </quotes>
        </ns1:getQuotesResponse>
    </env:Body>
</env:Envelope>

Any items which are enabled for packaging optimisation will now have a <packagingDescription> element returned in the <anything> response from the getQuotes or makeBooking call, as shown on the right hand side.

Along with other relevant details this tells the merchant that the items from the order will fit into the predefined box for sending to the customer. The <packagingDescription> tag presents the name of the predefined box, in this case “BigBox1”, for ease of reference. If multiple items are sent to the packagingOptimisation call, items flagged with an N in the <packagingOptimisation> tag will be ignored by the calculations tool and be returned as separate <anything> items in the XML result.

Considerations when enabling packagingOptimisation

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
         <faultcode>Err_State13</faultcode>
         <faultstring>The quote filter/s provided has not matched with any available quote.</faultstring>
         <faultactor>https://api.temando.com/soapServer.html</faultactor>
      </SOAP-ENV:Fault>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

If there is a packaging issue with the packagingOptimisation request an error response will be returned from the API. Typical issues are seen where there is no package large enough to cater for the item being shipped or where multiple items are requested to be optimised and there is no predefined package large enough for one of the items.

Sample Code

Below are sample codes in a number of common languages. They are intentionally simple to quickly demonstrate how to connect to Temando SOAP services, and might not follow best coding practices. Please modify them to adapt to your project’s requirements.

PHP

Download PHP Sample Code

Java

Download Java Sample Code

C# (C Sharp)

Download C# Sample Code

Use Cases for getQuotes

Brisbane to Melbourne

The full request xml could be found here.

With Package Optimisation

Getting quotes from the list of input carriers, for 2 packages, with packaging optimisation turned on.

The full request xml could be found here.

A few things worth noting about this request:

anythings

anythings

<anythings>
    <anything>
        <class>Freight</class>
        <mode>Less than load</mode>
        <packaging>Box</packaging>
        <distanceMeasurementType>Centimetres</distanceMeasurementType>
        <weightMeasurementType>Grams</weightMeasurementType>
        <length>18</length>
        <width>23</width>
        <height>16</height>
        <weight>180</weight>
        <packagingOptimisation>Y</packagingOptimisation>
        <quantity>1</quantity>
        <articles>
            <article>
                <description>Baby Pooh Led Magic Night Light</description>
                <sku>6767508</sku>
            </article>
        </articles>
    </anything>
    <anything>
        <class>Freight</class>
        <mode>Less than load</mode>
        <packaging>Box</packaging>
        <distanceMeasurementType>Centimetres</distanceMeasurementType>
        <weightMeasurementType>Grams</weightMeasurementType>
        <length>7</length>
        <width>10</width>
        <height>25</height>
        <weight>210</weight>
        <packagingOptimisation>Y</packagingOptimisation>
        <quantity>1</quantity>
        <articles>
            <article>
                <description>Winnie the Pooh Starry Night Cuddle Robe</description>
                <sku>3639911</sku>
            </article>
        </articles>
    </anything>
</anythings>
  • The number of articles supplied has to match with the quantity supplied.
  • packagingOptimisation is turned on for this quote. When this is the case, the response will include anythings with only one anything element, which is the packaging that accommodates all items in the request. This anything element must be used for the next step makeBooking (not anythings in the original getQuotes request)

clientId

clientId

<clientId>27937</clientId>

This is applicable if you have quoting on behalf of a client.

Quote filter

quoteFilter

<quoteFilter>
    <preference>Carriers Only</preference>
    <carriers>
        <carrier>
            <carrierId>54381</carrierId>
        </carrier>
    </carriers>
</quoteFilter>

There are 3 possible values for preference:

Cheapest Only a single quote be returned, which will be the cheapest quote available. Can be used for getQuotes and makeBooking.
Carriers Only Only those quotes that match with the carrier details supplied in the QuoteFilter. Can be used for getQuotes.
Carrier Order Only a single quote will be returned based off the order of the carrier details supplied in the QuoteFilter, with the first available quote matching the list being used. Can be used for getQuotes and makeBooking.

International Shipping

request extract

<ns1:getQuotes>
    <anythings>
        <anything>
            <class>General Goods</class>
            <subclass>Household Goods</subclass>
            <packaging>Carton</packaging>
            <qualifierFreightGeneralFragile>N</qualifierFreightGeneralFragile>
            <distanceMeasurementType>Centimetres</distanceMeasurementType>
            <weightMeasurementType>Grams</weightMeasurementType>
            <length>28</length>
            <width>23</width>
            <height>41</height>
            <weight>3200</weight>
            <quantity>1</quantity>
            <description>8T CARTONS: Nokia 2610</description>
            <articles>
                <article>
                    <description>Nokia 2610 Phone</description>
                    <sku>n2610</sku>
                    <hs>n2610AUUS</hs>
                    <countryOfOrigin>AU</countryOfOrigin>
                    <countryOfManufacture>CN</countryOfManufacture>
                    <composition>100% metal</composition>
                    <goodsValue>149.99</goodsValue>
                    <goodsCurrency>EUR</goodsCurrency>
                </article>
            </articles>
        </anything>
    </anythings>
    <anywhere>
        <itemNature>International</itemNature>
        <itemMethod>Door to Door</itemMethod>
        <originDescription>Temando Gold International</originDescription>
        <destinationCountry>US</destinationCountry>
        <destinationCode>89158</destinationCode>
        <destinationSuburb>LAS VEGAS</destinationSuburb>
        <destinationIs>Residence</destinationIs>
        <destinationBusNotifyBefore>N</destinationBusNotifyBefore>
        <destinationBusLimitedAccess>N</destinationBusLimitedAccess>
        <originBusNotifyBefore>Y</originBusNotifyBefore>
    </anywhere>
    <general>
        <!-- insurance -->
        <goodsValue>149.99</goodsValue>
        <goodsCurrency>EUR</goodsCurrency>
        <!-- internation requires below as well -->
        <termsOfTrade>Delivered Duty Unpaid</termsOfTrade>
    </general>
</ns1:getQuotes>

The full request xml could be found here.

For international shipping request:

  • Each article must include goodsValue and goodsCurrency
  • The general section must include goodsValue, goodsCurrency, and termsOfTrade.
  • The sum of goodsValue for all articles must be equal to goodsValue under general

Terminology

Term Meaning
Article The package to be shipped
Quote An individual quote for a carrier to provide the service.
Request The details of the item/s to be sent.
Booking A quote that has been accepted and payment received.
Booking Number Booking number allocated by the corresponding Carrier for the booking.
Manifest Consolidated list of daily consignment details. For further information please see our section on What is Manifesting.
Carrier A transportation company that provides the quote for the transportation of freight.
Local time The local time specified against the user’s Temando account.
GST Goods and Services Tax. 10% tax levied on all Australian freight (but not international). Note that the full tax situation is sufficiently complicated to be beyond the scope of this document.
HTTP Hyper Text Transfer Protocol
Soap Simple Object Access Protocol - A Specification for XML-based communication.
Wsdl Web Services Description Language - A specification for describing web services in terms of messages and operations.
XML eXtensible Markup Language - A method of formatting structured data in a way that purports to be human-readable.
XML Schema A data / structure model for XML allowing specification of fully typed complex data structures. The schemas defining the Temando API are available at http://api.temando.com/schema/2009_06/common.xsd

Frequently Asked Questions

What is Manifesting?

Manifesting is a service we can specifically enable for clients who have agreed to / meet certain volumes of freight and / or have arranged a permanent pick-up in place. This service needs to be activated / enabled on your account per carrier(s) who support the manifesting capability.

From a technical aspect, when manifesting is enabled - Temando will store all booked shipments internally with a status of awaiting collection. This status is only changed to complete when confirmManifest has been called and it is ONLY at this point where we send the carrier the shipment data. When manifesting is NOT enabled, each individual booking is parsed immediately to the relevant carrier’s platform upon the makeBooking request.

Following on from the above, cancelling shipments via the API can only be performed when a shipment has the status of awaiting collection (manifesting is enabled & is being stored in Temando). Any booked shipments that have already been parsed to the relevant carrier (ADHOC bookings) will need to be manually cancelled & credited back by the Temando support team liaising with the appropriate carrier (as it is no longer sitting in Temando).

Each Saved Address (origin) on your Temando Account should be assigned a unique Location entry in your manifesting portal. These are saved and sorted by the unique Reference description (which also links manifesting to your API). The more saved addresses you have (even with the exact same details), the more origin points in your manifesting location list.

What is the difference between getQuotes and getQuotesByRequest?

They offer the same functionalities. However, you are advised to use getQuotes. Its predecessor getQuotesByRequest will be deprecated sometime in the future.

What is the difference between makeBooking and makeBookingByRequest?

makeBooking is used for domestic shipping whereas makeBookingByRequest is used for international shipping.

For the makeBooking response, does Temando provide tracking details like
a tracking number or a URL that we can provide to our clients so they can track their item?

The consignment number that we provide in the makeBooking response can be used to track the parcels on the carrier’s tracking website.

Alternatively the requestId that is returned can be used to track the items in Temando portal

How do I get a list of registered locations for my account?

You could call getLocations service to get this information.

How do I create an account to use the API on production?

First, you need to create an account via our website. Once done, on the My Details section you will need to select which Account Type i.e. payment method you would like to use for your transactions with our API. Then please contact the Temando solution manager assigned to your account, and they will sort out the rest.

Is there a quick way to test Temando Soap API without writing any code?

SoapUI is a well known tool for web service testing. A freeware version (including open source) is available for download from the internet. With this tool you will be able to replicate the requests and responses that you will send and receive when using the Temando API from a code base. The soapUI tool is available from http://www.soapui.org/.

For help on how to setup SoapUI, please refer to Appendix A in the Developer Guide

API Overview

Example of a Soap request message (getRequest in this instance).

1.  <?xml version="1.0" encoding="UTF-8"?>
2.  <soapenv:Envelope
3.           xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
4.           xmlns:xsd="http://www.w3.org/2001/XMLSchema"
5.           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
6.      <soapenv:Header>
7.          <wsse:Security
8.             xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/04/secext">
9.              <wsse:UsernameToken>
10.                 <wsse:Username>username</wsse:Username>
11.                 <wsse:Password>password</wsse:Password>
12.             </wsse:UsernameToken>
13.         </wsse:Security>
14.     </soapenv:Header>
15.     <soapenv:Body>
16.         <tem:getRequest
17.           xmlns:tem="http://api-demo.temando.com/schema/2009_06/server.xsd">
18.             <requestId>100000</requestId>
19.             <detail>Detailed</detail>
20.         </tem:getRequest>
21.     </soapenv:Body>
22. </soapenv:Envelope>

Communication with the API uses a simple request/response protocol based on Soap requests over a HTTP transport layer. The request message is submitted to the API server with a POST request to the API URI - the server responds with the response message as the content body.

Currently the only recognized header is the WS-Security Security header.

Line 1 XML header declaration (recommended but technically optional . In the absence of a declaration the message is assumed to use XML 1.0 (either 1.0 or 1.1 is supported). If the header is omitted, or is present but specifies no character encoding, the message MUST be encoded in UTF-8. Note that irrespective of the message’s encoding, the contents of the message must be mappable to the HP Roman-8 character set. Currently supported character sets are UTF-8, UTF-16 (big or little endian), ISO-8859-1 and US-ASCII.
Lines 2-5, 22 Soap envelope wrapper - top-level document element.
Lines 6-14 Soap headers. must be specified in all requests.
Liners 15,21 Soap body. Contains the actual request message from one of the operations defined in this document.
Lines 16-20 Main request body (in this case a getRequest request).

The response body is similar but does not currently include any Soap headers.

Error Handling

Errors caused by an invalid request message will generate a Soap fault in the response body and the operation will have no further effect (see Soap Faults for a list of standard fault codes).

User Authentication

Example WS-Security header block (occurs within the Soap header):

<wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/04/secext">
    <wsse:UsernameToken>
        <wsse:Username>username</wsse:Username>
        <wsse:Password>password</wsse:Password>
    </wsse:UsernameToken>
</wsse:Security>

Example authentication fault:

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Access03</faultcode>
            <faultstring>The login details you have provided are not a valid Username and Password combination.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

User authentication is performed using the WS-Security standard Soap headers, which must be included in every request message. Presently only username/password authentication is supported; however support for SSL certificate based authentication and signed xml are intended for a future release. Users may further be restricted by IP address.

An accepted security header consists of a single Security element containing exactly one UsernameToken, which in turn contains Username and Password elements. The Username and Password elements in turn supply the user credentials in plain text (for this reason, an SSL connection is required for transport-level security).

If authentication fails for whatever reason, the server will return a Soap Fault indicating the failure as defined within Soap Faults.

Restrictions

There are currently no restrictions or limitations on the service requests themselves or returned data (eg. maximum number of quotes, etc.) but this may change in the future.

createLocation

The createLocation operation registers a location that can have attached stock levels, facilities, and carrier account information.

A stored location is required for a range of carriers to associate carrier information with the location.

A stored location could be used as origin or destination location when getting a quote or making a booking, instead of specifying the full address.

All carriers that are set to manifest must book against a stored location and manifest against that stored location.

On success, the response is an empty createLocationResponse.

Otherwise, a SoapFault is thrown with the details of the exception.

Request

createLocation request schema

<xsd:element name="createLocation">
    <xsd:complexType>
        <xsd:all>
            <xsd:element name="clientId" type="com:ClientId"
                minOccurs="0" />
            <xsd:element name="location" type="com:Location" />
        </xsd:all>
    </xsd:complexType>
</xsd:element>

Sample createLocation request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://api-demo.temando.com/schema/2009_06/server.xsd">
    <soapenv:Header>
        <Security>
            <UsernameToken>
                <Username>TEMANDOTEST</Username>
                <Password>temandopass1</Password>
            </UsernameToken>
        </Security>
    </soapenv:Header>
    <soapenv:Body>
        <ser:createLocation>
            <location>
                <description>SYD</description>
                <clientId>20420</clientId>
                <type>Origin</type>
                <contactName>Test Name</contactName>
                <street>44 Smith Road</street>
                <suburb>Sydney</suburb>
                <state>NSW</state>
                <code>2000</code>
                <country>AU</country>
                <phone1>21212121</phone1>
                <email>sydneyTest@temando.com</email>
            </location>
        </ser:createLocation>
    </soapenv:Body>
</soapenv:Envelope>

Child content

Field Type Occurs Description
clientId simple Optional The client id of the client’s account.
location simple Required The location description.

Response

Sample createLocation response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api-demo.temando.com/schema/2009_06/server.xsd">
   <SOAP-ENV:Body>
      <ns1:createLocationResponse/>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

On success, the response is an empty createLocationResponse.

getLocations

The getLocations operation returns a list of locations against a client id. The list could also be filtered by location description location type.

If a query contains invalid data then a SoapFault is thrown with the details of the exception.

Request

getLocations request schema

<xsd:element name="getLocations">
    <xsd:complexType>
        <xsd:all>
            <xsd:element name="clientId" type="com:ClientId"
                minOccurs="0" />
            <xsd:element name="description" type="com:LocationName"
                minOccurs="0" />
            <xsd:element name="type" type="com:LocationPosition"
                minOccurs="0" />
        </xsd:all>
    </xsd:complexType>
</xsd:element>

Sample getLocations request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://api-demo.temando.com/schema/2009_06/server.xsd">
   <soapenv:Header>
      <Security>
         <UsernameToken>
            <Username>TEMANDOTEST</Username>
            <Password>temandopass1</Password>
         </UsernameToken>
      </Security>
   </soapenv:Header>
   <soapenv:Body>
      <ser:getLocations>
<!--         <clientId></clientId-->
<!--         <description></description>-->
         <type>Origin</type>
      </ser:getLocations>
   </soapenv:Body>
</soapenv:Envelope>

Child content

Field Type Occurs Description
clientId simple Optional* The client ID of the client’s account.
description simple Optional The location description.
type simple Optional The location origin.

Further Restrictions:

Further to the restrictions applied by the field’s base type and element conditions (eg. minOccurs=“0”) the following rules will also be applied after the data has passed the XML tests:

Field Further restrictions
clientId Only applies and mandatory for users with API (Affiliate): General access rights. Any supplied values are disregarded in all other cases.

Response

Sample getLocations response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api-demo.temando.com/schema/2009_06/server.xsd">
   <SOAP-ENV:Body>
      <ns1:getLocationsResponse>
         <locations>
            <location>
               <description>Sydney Warehouse</description>
               <type>Origin</type>
               <contactName>Temando User</contactName>
               <companyName>Temando</companyName>
               <street>Level 4, 140 William Street</street>
               <suburb>WOOLLOOMOOLOO</suburb>
               <state>NSW</state>
               <code>2011</code>
               <country>AU</country>
               <phone1>02 1234 5678</phone1>
               <phone2/>
               <fax/>
               <email>sales@temando.com</email>
               <loadingFacilities>Y</loadingFacilities>
               <forklift>N</forklift>
               <dock>N</dock>
               <limitedAccess>N</limitedAccess>
               <postalBox>N</postalBox>
               <auspostMerchantLocationId/>
               <auspostLodgementFacility/>
               <manifesting>Y</manifesting>
               <zones/>
            </location>
         </locations>
      </ns1:getLocationsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Child Content:

Field Type Occurs Description
Location List Always The locations which match the request criteria.

getQuotes

The getQuotes operation retrieves all available quotes (automatically generated from a carrier’s rate information) based on the supplied request details.

The response is a getQuotesResponse, and contains a list of all available quotes. Quote results are not listed in any particular order.

If a query contains invalid data then a SoapFault is thrown with the details of the exception. dsdsss

Request

getQuotes request schema

<xsd:element name="getQuotes">
    <xsd:complexType>
        <xsd:all>
            <xsd:element name="anythings">
                <xsd:complexType>
                    <xsd:sequence>
                        <xsd:element name="anything" type="com:Anything" maxOccurs="10"/>
                    </xsd:sequence>
                </xsd:complexType>
            </xsd:element>
            <xsd:element name="anywhere" type="com:Anywhere"/>
            <xsd:element name="anytime" type="com:Anytime" minOccurs="0"/>
            <xsd:element name="general" type="com:General" minOccurs="0"/>
            <xsd:element name="origin" type="com:Location"/>
            <xsd:element name="destination" type="com:Location"/>
            <xsd:element name="clientId" type="com:ClientId" minOccurs="0"/>
        </xsd:all>
    </xsd:complexType>
</xsd:element>

Sample getQuotes request

Request quotes for 2 cartons 10 x 10 x 10cm with weight of 1kg, door-to-door, from a business in Brisbane (4000) (with notifications before pick-up) to a business in Sydney (2000) with pickup on 01 July 2009 in the morning.

Note that 'readyDate' cannot be in the past, or weekends, or public holidays.
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
        xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Header>
        <wsse:Security
          xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/04/secext">
            <wsse:UsernameToken>
                <wsse:Username>TEMANDOTEST</wsse:Username>
                <wsse:Password>temandopass1</wsse:Password>
            </wsse:UsernameToken>
        </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
        <tem:getQuotes
          xmlns:tem="http://api-demo.temando.com/schema/2009_06/server.xsd">
            <anythings>
                <anything>
                    <class>Freight</class>
                    <mode>Less than load</mode>
                    <packaging>Carton</packaging>
                    <qualifierFreightGeneralFragile>N</qualifierFreightGeneralFragile>
                    <distanceMeasurementType>Centimetres</distanceMeasurementType>
                    <weightMeasurementType>Kilograms</weightMeasurementType>
                    <length>10</length>
                    <width>10</width>
                    <height>10</height>
                    <weight>1</weight>
                    <quantity>2</quantity>
                    <description>Contains hats.</description>
                </anything>
            </anythings>
            <anywhere>
                <itemNature>Domestic</itemNature>
                <itemMethod>Door to Door</itemMethod>
                <originCountry>AU</originCountry>
                <originCode>4000</originCode>
                <originSuburb>Brisbane</originSuburb>
                <destinationCountry>AU</destinationCountry>
                <destinationCode>2000</destinationCode>
                <destinationSuburb>Sydney</destinationSuburb>
                <destinationIs>Residence</destinationIs>
                <destinationResNotifyBefore>N</destinationResNotifyBefore>
                <destinationResLimitedAccess>N</destinationResLimitedAccess>
                <originIs>Business</originIs>
                <originBusNotifyBefore>Y</originBusNotifyBefore>
                <originBusLimitedAccess>N</originBusLimitedAccess>
            </anywhere>
            <anytime>
                <readyDate>2015-12-31</readyDate>
                <readyTime>PM</readyTime>
            </anytime>
            <general>
                <goodsValue>50.00</goodsValue>
            </general>
        </tem:getQuotes>
    </soapenv:Body>
</soapenv:Envelope>    

Child content

The full details of a request. This includes all the details about what is being sent, where it is being sent from and to, and when it is to be sent.

Field Type Occurs Description
anythings list Required The details about the items being sent. Note that anything has a inner element called packagingOptimisation to specify whether the supplied details should be used to find an optimal packaging solution. This option only works if predefined packaging types have been stored for the account. For further information, please see our section on What is Packaging Optimisation.
anywhere complex Required The details about where the items are being sent from/to.
clientId simple Optional* The client id of the client’s account.
anytime complex Optional The details about when the items are being sent. If not specified defaults to the next available date (ie. ASAP).
general complex Optional The general details about the items being sent.
origin complex Optional The details about where an items is being sent from or the originating address. Any matching values from the anywhere element (if supplied) will override those values supplied in this element.
destination complex Optional The details about where an items is being sent to or the final destination address. Any matching values from the anywhere element (if supplied) will override those values supplied in this element.
quoteFilter complex Optional The filtering to be applied to the available quotes.

Further Restrictions:

Further to the restrictions applied by the field’s base type and element conditions (eg. minOccurs=“0”) the following rules will also be applied after the data has passed the XML tests:

Field Further restrictions
clientId Only applies and mandatory for users with API (Affiliate): General access rights. Any supplied values are disregarded in all other cases.

Response

getQuotes response schema

<xsd:element name="getQuotesResponse">
    <xsd:complexType>
        <xsd:sequence>
            <xsd:element name="quote" type="com:AvailableQuote"/>
        </xsd:sequence>
    </xsd:complexType>
</xsd:element>

Sample getQuotes response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api-demo.temando.com/schema/2009_06/server.xsd">
    <SOAP-ENV:Body>
        <ns1:getQuotesResponse>
            <quotes>
                <quote>
                    <generated>Automatically</generated>
                    <accepted>N</accepted>
                    <totalPrice>256.97</totalPrice>
                    <basePrice>233.61</basePrice>
                    <tax>23.36</tax>
                    <currency>AUD</currency>
                    <deliveryMethod>Next Flight: Extra Costs Apply for Regional Areas</deliveryMethod>
                    <usingGeneralRail>N</usingGeneralRail>
                    <usingGeneralRoad>N</usingGeneralRoad>
                    <usingGeneralSea>N</usingGeneralSea>
                    <usingExpressAir>Y</usingExpressAir>
                    <usingExpressRoad>N</usingExpressRoad>
                    <etaFrom>1</etaFrom>
                    <etaTo>1</etaTo>
                    <guaranteedEta>Y</guaranteedEta>
                    <adjustments>
                        <adjustment>
                            <description>Credit Card Payment Adjustment</description>
                            <amount>4.67</amount>
                            <tax>0.47</tax>
                        </adjustment>
                        <adjustment>
                            <description>Credit Payment Adjustment</description>
                            <amount>-4.67</amount>
                            <tax>-0.47</tax>
                        </adjustment>
                    </adjustments>
                    <inclusions/>
                    <extras>
                        <extra>
                            <summary>Carbon Offset</summary>
                            <details>Carbon Offset</details>
                            <totalPrice>0.67</totalPrice>
                            <basePrice>0.61</basePrice>
                            <tax>0.06</tax>
                            <adjustments>
                                <adjustment>
                                    <description>Credit Card Payment Adjustment</description>
                                    <amount>0.01</amount>
                                    <tax>0</tax>
                                </adjustment>
                            </adjustments>
                        </extra>
                        <extra>
                            <summary>Footprints</summary>
                            <details>Footprints</details>
                            <totalPrice>1</totalPrice>
                            <basePrice>1</basePrice>
                            <tax>0</tax>
                            <adjustments>
                                <adjustment>
                                    <description>Credit Card Payment Adjustment</description>
                                    <amount>0.02</amount>
                                    <tax>0</tax>
                                </adjustment>
                            </adjustments>
                        </extra>
                    </extras>
                    <carrier>
                        <id>54405</id>
                        <companyName>Startrack__</companyName>
                        <companyContact>Customer Service</companyContact>
                        <streetAddress>Level 7 440 Elizabeth St</streetAddress>
                        <streetSuburb>Melbourne</streetSuburb>
                        <streetCity>Melbourne</streetCity>
                        <streetState>VIC</streetState>
                        <streetCode>3000</streetCode>
                        <streetCountry>AU</streetCountry>
                        <postalAddress>Level 7 440 Elizabeth St</postalAddress>
                        <postalSuburb>Melbourne</postalSuburb>
                        <postalCity>Melbourne</postalCity>
                        <postalState>VIC</postalState>
                        <postalCode>3000</postalCode>
                        <postalCountry>AU</postalCountry>
                        <phone1>13 12 13</phone1>
                        <email/>
                        <website>http://www.startrack.com.au/</website>
                    </carrier>
                </quote>
            </quotes>
        </ns1:getQuotesResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Child Content:

Field Type Occurs Description
quotes list Always A list of available quotes matching a particular request.

makeBooking

The makeBooking operation creates a request entry in the system, creates and associates a quote and processes a payment.

The response message is a makeBookingResponse, and contains a request id.

If a query contains invalid data then a SoapFault is thrown with the details of the exception.

Request

makeBooking request schema

<xsd:element name="makeBooking">
    <xsd:complexType>
        <xsd:all>
            <xsd:element name="anythings">
                <xsd:complexType>
                    <xsd:sequence>
                        <xsd:element name="anything" type="com:Anything" maxOccurs="10"/>
                    </xsd:sequence>
                </xsd:complexType>
            </xsd:element>
            <xsd:element name="anywhere" type="com:Anywhere"/>
            <xsd:element name="anytime" type="com:Anytime" minOccurs="0"/>
            <xsd:element name="general" type="com:General" minOccurs="0"/>
            <xsd:element name="origin" type="com:Location"/>
            <xsd:element name="destination" type="com:Location"/>
            <xsd:element name="quote" type="com:BookingQuote"/>
            <xsd:element name="payment" type="com:Payment"/>
            <xsd:element name="instructions" type="com:Instructions"
           minOccurs="0"/>
            <xsd:element name="comments" type="com:Comments" minOccurs="0"/>
            <xsd:element name="reference" type="com:ClientReference"
           minOccurs="0"/>
            <xsd:element name="promotionCode" type="com:PromotionCode"
           minOccurs="0"/>
            <xsd:element name="clientId" type="com:ClientId"
           minOccurs="0"/>
            <xsd:element name="labelPrinterType" type="com:LabelPrinterType"
           minOccurs="0"/>
        </xsd:all>
    </xsd:complexType>
</xsd:element>

Sample makeBooking request

Book the quote 2 cartons 10 x 10 x 10cm with weight of 1kg, door-to-door, from a business in Brisbane (4000) (with notifications before pick-up) to a business in Sydney (2000) with pickup on 01 July 2009 in the morning.  Payment method is with a account.

Note that 'readyDate' cannot be in the past, or weekends, or public holidays.
<soapenv:Envelope xmlns:ser="http://api-demo.temando.com/schema/2009_06/server.xsd" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Header>
        <Security>
            <UsernameToken>
                <Username>TEMANDOTEST</Username>
                <Password>temandopass1</Password>
            </UsernameToken>
        </Security>
    </soapenv:Header>
    <soapenv:Body>
        <ser:makeBooking>
            <anythings>
                <anything>
                    <class>General Goods</class>
                    <subclass>Household Goods</subclass>
                    <packaging>Box</packaging>
                    <distanceMeasurementType>Centimetres</distanceMeasurementType>
                    <weightMeasurementType>Grams</weightMeasurementType>
                    <length>10</length>
                    <width>10</width>
                    <height>10</height>
                    <weight>1000</weight>
                    <quantity>1</quantity>
                </anything>
            </anythings>
            <anywhere>
                <itemNature>Domestic</itemNature>
                <itemMethod>Door to Door</itemMethod>
                <originCountry>AU</originCountry>
                <originCode>2000</originCode>
                <originSuburb>Sydney</originSuburb>
                <originIs>Residence</originIs>
                <destinationCountry>AU</destinationCountry>
                <destinationCode>2000</destinationCode>
                <destinationSuburb>Sydney</destinationSuburb>
                <destinationIs>Business</destinationIs>
            </anywhere>
            <origin>
                <contactName>Test Contact</contactName>
                <companyName>Test Company</companyName>
                <street>123 Test St</street>
                <suburb>SYDNEY</suburb>
                <code>2000</code>
                <country>AU</country>
                <phone1>0000000000</phone1>
                <phone2/>
                <fax/>
                <email>test@test.com</email>
            </origin>
            <destination>
                <contactName>Test Contact</contactName>
                <companyName/>
                <street>123 Test St</street>
                <suburb>SYDNEY</suburb>
                <code>2000</code>
                <country>AU</country>
                <phone1>0000000000</phone1>
                <phone2/>
                <fax/>
                <email>test@test.com</email>
            </destination>
            <quoteFilter>
                <preference>Carriers Only</preference>
                <carriers>
                    <carrier>
                        <carrierId>60027</carrierId>
                    </carrier>
                </carriers> 
            </quoteFilter>
            <payment>
                <paymentType>Account</paymentType>
            </payment>
            <clientId>20420</clientId>
        </ser:makeBooking>
    </soapenv:Body>
</soapenv:Envelope>

Child Content:

The details required to lodge a request and an accepted quote. Also contains the details required for payment processing.

Field Type Occurs Description
anythings list Required The details about the items are being sent.
anywhere complex Required The details about where the items are being sent from/to.
payment complex Required The details about the payment for the quote.
destination complex Required The details about where the items are being sent to or the final destination address.
anytime complex Optional The details about when the items are being sent. If not specified defaults to the next available date.
general complex Optional The general details about the items being sent.
origin complex Required The details about where items are being sent from or the originating address.
returnto complex Optional The details about where items should be returned to if this location is different to the origin (eg. PO Box or Locked Bag return address). This will be the address displayed on labels allowing the user to provide their actual origin to the carrier but not display this information to the client.
quote complex Optional Specific details about a quote to be accepted.
quoteFilter complex Optional* The filtering to be applied to the available quotes. This filtering must result in a single quote or an exception will be thrown.
instructions simple Optional Delivery instructions relating to the request.
comments simple Optional Client comments relating to the request.
reference simple Optional Client reference relating to the request.
promotionCode simple Optional* Temando code used for promotions or identifying sales representatives.
labelPrinterType simple Optional The type of printer that will be used for printing the item labels. If no labels required this element should not be supplied.
responseExclusions complex Optional The fields to exclude from the makeBookingResponse.

Further Restrictions:

Further to the restrictions applied by the field’s base type and element conditions (eg. minOccurs=“0”) the following rules will also be applied after the data has passed the XML tests:

Field Further restrictions
promotionCode Mandatory for users with API (Affiliate): General access rights.
quoteFilter Mandatory if no quote was supplied.

Response

makeBooking response schema

<xsd:element name="makeBookingResponse">
    <xsd:complexType>
        <xsd:all>
            <xsd:element name="requestId" type="xsd:positiveInteger"/>
            <xsd:element name="bookingNumber" type="com:BookingNumber"
           minOccurs="0"/>
            <xsd:element name="consignmentNumber" type="com:ConsignmentNumber"
           minOccurs="0"/>
            <xsd:element name="consignmentDocument" type="com:ConsignmentDocument"
           minOccurs="0"/>
            <xsd:element name="consignmentDocumentType"
           type="com:ConsignmentDocumentType" minOccurs="0"/>
            <xsd:element name="labelDocument" type="com:LabelDocument"
           minOccurs="0"/>
            <xsd:element name="labelDocumentType"
           type="com:LabelDocumentType" minOccurs="0"/>
            <xsd:element name="commercialInvoiceDocument"
           type="com:CommercialInvoiceDocument" minOccurs="0"/>
            <xsd:element name="commercialInvoiceDocumentType"
           type="com:CommercialInvoiceDocumentType" minOccurs="0"/>
            <xsd:element name="anytime" type="com:Anytime" minOccurs="0"/>
            <xsd:element name="manifestNumber" type="com:ManifestNumber"
           minOccurs="0"/>
            <xsd:element name="articles" minOccurs="0">
                <xsd:complexType>
                    <xsd:sequence>
                        <xsd:element name="article" type="com:Article"/>
                    </xsd:sequence>
                </xsd:complexType>
            </xsd:element>
        </xsd:all>
    </xsd:complexType>
</xsd:element>

Sample makeBooking response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api-demo.temando.com/schema/2009_06/server.xsd">
   <SOAP-ENV:Body>
      <ns1:makeBookingResponse>
         <requestId>10008066</requestId>
         <consignmentNumber>TXN005077978</consignmentNumber>
         <consignmentDocument>JVBERi0xLjQK (SHORTENED HERE)</consignmentDocument>
         <consignmentDocumentType>application/pdf</consignmentDocumentType>
         <anytime>
            <readyDate>2015-01-19</readyDate>
            <readyTime>PM</readyTime>
         </anytime>
         <quote id="10790112">
            <generated>Automatically</generated>
            <accepted>Y</accepted>
            <consignmentNumber>TXN005077978</consignmentNumber>
            <manifestNumber>00070933</manifestNumber>
            <articles>
               <article>
                  <anythingIndex>1</anythingIndex>
                  <articleNumber>11293323005077978001</articleNumber>
               </article>
            </articles>
            <totalPrice>10.5</totalPrice>
            <basePrice>9.55</basePrice>
            <tax>0.95</tax>
            <currency>AUD</currency>
            <deliveryMethod>Overnight Express (AIR) - Auth to Leave (ATL)</deliveryMethod>
            <usingGeneralRail>N</usingGeneralRail>
            <usingGeneralRoad>N</usingGeneralRoad>
            <usingGeneralSea>N</usingGeneralSea>
            <usingExpressAir>Y</usingExpressAir>
            <usingExpressRoad>N</usingExpressRoad>
            <etaFrom>1</etaFrom>
            <etaTo>1</etaTo>
            <guaranteedEta>N</guaranteedEta>
            <adjustments>
               <adjustment>
                  <description>Credit Card Payment Adjustment</description>
                  <amount>0.19</amount>
                  <tax>0.02</tax>
               </adjustment>
               <adjustment>
                  <description>Credit Payment Adjustment</description>
                  <amount>-0.19</amount>
                  <tax>-0.02</tax>
               </adjustment>
            </adjustments>
            <inclusions/>
            <extras/>
            <carrier>
               <id>60027</id>
               <companyName>TNT - Auth To Leave</companyName>
               <companyContact>Stewart Seddon</companyContact>
               <streetAddress>127 Riawena Road</streetAddress>
               <streetSuburb>Salisbury</streetSuburb>
               <streetCity>Brisbane</streetCity>
               <streetState>QLD</streetState>
               <streetCode>4107</streetCode>
               <streetCountry>AU</streetCountry>
               <postalAddress>127 Riawena Road</postalAddress>
               <postalSuburb>Salisbury</postalSuburb>
               <postalCity>Brisbane</postalCity>
               <postalState>QLD</postalState>
               <postalCode>4107</postalCode>
               <postalCountry>AU</postalCountry>
               <phone1>131150</phone1>
               <email>tntatl@temando.com</email>
               <website>http://www.tntexpress.com.au/interaction/asps/trackdtl_tntau.asp</website>
            </carrier>
         </quote>
         <manifestNumber>00070933</manifestNumber>
         <articles>
            <article>
               <articleId>14320596</articleId>
               <anythingIndex>1</anythingIndex>
               <articleNumber>11293323005077978001</articleNumber>
            </article>
         </articles>
      </ns1:makeBookingResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Child Content:

Field Type Occurs Description
requestId positiveInteger Always The id of the created request.
consignmentNumber simple Optional The carrier’s consignment number identifies a logical grouping of goods that has been consigned. Can be retrieve at a later date via the getRequest call.
consignmentDocument simple Optional The carrier’s consignment document. This document is a combination of the label document and manifest document. This is optional as the carrier may not provide a document. Can be retrieved at a later date via the getRequest call.
consignmentDocumentType simple Optional The type of the carrier’s consignment document. This is only provided if an entry for the consignmentDocument field is provided. Can be retrieve at a later date via the getRequest call.
labelDocument simple Optional The carrier’s label document. This is optional as the carrier may not provide a document. Can be retrieved at a later date via the getRequest call.
labelDocumentType simple Optional The type of the carrier’s label document. This is only provided if an entry for the labelDocument field is provided. Can be retrieve at a later date via the getRequest call.
commercialInvoiceDocument simple Optional The commercial invoice required for international deliveries. This is optional as the document is not required for domestic delivery. Can be retrieved at a later date via the getRequest call.
commercialInvoiceDocumentType simple Optional The type of the commercial invoice document. This is only provided if an entry for the commercialInvoiceDocument field is provided. Can be retrieve at a later date via the getRequest call.
anythings list Optional The details about the items being sent. This will only be returned if either the request had specified packaging logic to be applied (in which case the calculated packaging is provided) or if item descriptions had been supplied (in which case the full details of the items are provided, eg. length, width, etc). This is done to ensure that the user has access to the anything details that were calculated by the system and then used for quote calculation.
anytime complex Optional The details about when the items are being sent. Only returned if an anytime element was not supplied in the request.
origin complex Optional The details about where the items are being sent from. This will only be returned if the origin details have not been provided. This would occur if the system is calculating the origin location for the user. The details are provided to ensure that the user knows the origin calculated by the system and then used for quote calculation.
quote complex Optional The details about the quote used for the booking. This occurs only if a quoteFilter was provided in the request to be accepted. The details are provided to ensure that the user knows the actual quote used by the system for the booking.
manifestNumber simple Optional The carrier’s manifest number identifies a logical grouping of consignments. This is optional as the carrier may not require this or a number has not yet been assigned (ie. request has not been confirmed for manifesting). Can be retrieve at a later date via the getRequest call.
articles list Optional The details about the individual items being sent.
bookingNumber simple Optional The carrier’s booking number for the request. This is optional as the carrier may be required to manually enter this reference. Can be retrieved at a later date via the getRequest call.

getRequest

The getRequest operation retrieves a request and associated details based on the supplied information.

The response message is a getRequestResponse, and contains all information relating to a request.

The received data are in the below order of preference:

  • requestId
  • consignmentNumber
  • bookingNumber
  • reference

If all data are provided, then only first value in the above list will be used in the query. For example, if requestId and consignmentNumber are provided, then consignmentNumber will be ignored.

If a query contains invalid data then a SoapFault is thrown with the details of the exception.

Request

getRequest request schema

<xsd:element name="getRequest">
    <xsd:complexType>
        <xsd:all>
            <xsd:element name="requestId" type="xsd:positiveInteger" minOccurs="0"/>
            <xsd:element name="consignmentNumber" type="tns:ConsignmentNumber" minOccurs="0"/>
            <xsd:element name="bookingNumber" type="com:BookingNumber" minOccurs="0"/>
            <xsd:element name="reference" type="com:ClientReference" minOccurs="0"/>
            <xsd:element name="detail" type="com:Detail" minOccurs="0"/>
            <xsd:element name="labelPrinterType" type="com:LabelPrinterType" minOccurs="0"/>
            <xsd:element name="responseExclusions" type="com:ResponseExclusions" minOccurs="0"/>
        </xsd:all>
    </xsd:complexType>
</xsd:element>    

Sample getRequest request

Retrieve request details for the request with the id of “100000”. Note that the request specifies that article labels are to be excluded from the response. This helps reduce transaction time.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header>
      <wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/04/secext">
         <wsse:UsernameToken>
            <wsse:Username>TEMANDOTEST</wsse:Username>
            <wsse:Password>temandopass1</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <tem:getRequest xmlns:tem="http://api-demo.temando.com/schema/2009_06/server.xsd">
         <requestId>8985522</requestId>
         <detail>Detailed</detail>
         <responseExclusions>
            <documents>
               <articleLabels>Y</articleLabels>
            </documents>
         </responseExclusions>
      </tem:getRequest>
   </soapenv:Body>
</soapenv:Envelope>

Child Content:

Field Type Occurs Description
requestId positiveInteger Optional* The request id of the request required.
consignmentNumber simple Optional* The carrier’s consignment number.
bookingNumber simple Optional The carrier’s booking number for the request.
reference simple Optional* Client reference relating to the request.
detail simple Optional Specifies the amount of detail required in the returned response. If no value supplied will default to Summary.
labelPrinterType simple Optional The type of printer that will be used for printing the item labels. If no labels required this element should not be supplied. Will only be used if supplied detail value is Detailed.
responseExclusions complex Optional The fields to exclude from getRequestResponse

Further Restrictions:

Further to the restrictions applied by the field’s base type and element conditions (eg. minOccurs=“0”) the following rules will also be applied after the data has passed the XML tests:

Field Further restrictions
requestId Mandatory if consignmentNumber and reference are not supplied.
consignmentNumber Mandatory if requestId and reference are not supplied.
reference Mandatory if requestId and consignmentNumber are not supplied.

Response

getRequest response schema

<xsd:element name="getRequestResponse">
    <xsd:complexType>
        <xsd:all>
            <xsd:element name="request" type="com:Request"/>
        </xsd:all>
    </xsd:complexType>
</xsd:element>

Sample getRequest response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api-demo.temando.com/schema/2009_06/server.xsd">
   <SOAP-ENV:Body>
      <ns1:getRequestResponse>
         <request id="8985522">
            <status>Awaiting Booking</status>
            <anythings>
               <anything>
                  <class>General Goods</class>
                  <subclass>Household Goods</subclass>
                  <packaging>Box</packaging>
                  <qualifierFreightGeneralFragile>N</qualifierFreightGeneralFragile>
                  <distanceMeasurementType>Centimetres</distanceMeasurementType>
                  <weightMeasurementType>Grams</weightMeasurementType>
                  <length>10</length>
                  <width>10</width>
                  <height>10</height>
                  <weight>1000</weight>
                  <quantity>1</quantity>
               </anything>
            </anythings>
            <anywhere>
               <itemNature>Domestic</itemNature>
               <itemMethod>Door to Door</itemMethod>
               <originCountry>AU</originCountry>
               <originCode>4000</originCode>
               <originSuburb>BRISBANE</originSuburb>
               <destinationCountry>AU</destinationCountry>
               <destinationCode>2000</destinationCode>
               <destinationSuburb>SYDNEY</destinationSuburb>
               <destinationIs>Residence</destinationIs>
               <originIs>Business</originIs>
               <originBusForklift>Y</originBusForklift>
            </anywhere>
            <anytime>
               <readyDate>2014-07-29</readyDate>
               <readyTime>PM</readyTime>
            </anytime>
            <general/>
            <origin>
               <contactName>Test Contact</contactName>
               <companyName>Test Company</companyName>
               <street>123 Test St</street>
               <suburb>BRISBANE</suburb>
               <state>QLD</state>
               <code>4000</code>
               <country>AU</country>
               <phone1>123456789</phone1>
               <email>test@test.com</email>
            </origin>
            <destination>
               <contactName>Test Contact</contactName>
               <companyName/>
               <street>123 Test St</street>
               <suburb>SYDNEY</suburb>
               <state>NSW</state>
               <code>2000</code>
               <country>AU</country>
               <phone1>123456789</phone1>
               <email>test@test.com</email>
            </destination>
            <returnto>
               <contactName>Test Contact</contactName>
               <companyName/>
               <street>123 Test St</street>
               <suburb>MELBOURNE</suburb>
               <state>VIC</state>
               <code>3000</code>
               <country>AU</country>
               <phone1>123456789</phone1>
               <email>test@test.com</email>
            </returnto>
            <quotes>
               <quote id="10781896">
                  <generated>Automatically</generated>
                  <consignmentNumber>CPAYJRZ0577083</consignmentNumber>
                  <consignmentDocument>JVBERi0xLj6Hrl</consignmentDocument>
                  <consignmentDocumentType>application/pdf</consignmentDocumentType>
                  <manifestNumber>CPAYJRM0452332</manifestNumber>
                  <articles>
                     <article>
                        <articleId>14298284</articleId>
                        <anythingIndex>1</anythingIndex>
                        <articleNumber>CPAYJRZ0577083001</articleNumber>
                     </article>
                  </articles>
                  <totalPrice>7.91</totalPrice>
                  <basePrice>7.19</basePrice>
                  <tax>0.72</tax>
                  <currency>AUD</currency>
                  <deliveryMethod>1 Kg Parcel</deliveryMethod>
                  <usingGeneralRail>N</usingGeneralRail>
                  <usingGeneralRoad>Y</usingGeneralRoad>
                  <usingGeneralSea>N</usingGeneralSea>
                  <usingExpressAir>N</usingExpressAir>
                  <usingExpressRoad>N</usingExpressRoad>
                  <etaFrom>1</etaFrom>
                  <etaTo>1</etaTo>
                  <guaranteedEta>N</guaranteedEta>
                  <adjustments>
                     <adjustment>
                        <description>Credit Card Payment Adjustment</description>
                        <amount>0.14</amount>
                        <tax>0.01</tax>
                     </adjustment>
                     <adjustment>
                        <description>Credit Payment Adjustment</description>
                        <amount>-0.14</amount>
                        <tax>-0.01</tax>
                     </adjustment>
                  </adjustments>
                  <inclusions/>
                  <extras/>
                  <carrier>
                     <id>54425</id>
                     <companyName>Couriers Please</companyName>
                     <companyContact>Admiin</companyContact>
                     <streetAddress>Unit 4, 29-33 Carter St</streetAddress>
                     <streetSuburb>Homebush</streetSuburb>
                     <streetCity>Sydney</streetCity>
                     <streetState>NSW</streetState>
                     <streetCode>2140</streetCode>
                     <streetCountry>AU</streetCountry>
                     <postalAddress>Unit 4, 29-33 Carter St</postalAddress>
                     <postalSuburb>Homebush</postalSuburb>
                     <postalCity>Sydney</postalCity>
                     <postalState>NSW</postalState>
                     <postalCode>2140</postalCode>
                     <postalCountry>AU</postalCountry>
                     <phone1>1300 163 244</phone1>
                     <email>enquiries@couriersplease.com.au</email>
                     <website>http://www.couriersplease.com.au/ezytrak</website>
                  </carrier>
               </quote>
            </quotes>
         </request>
      </ns1:getRequestResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Child Content:

The details relating to a lodged request and associated quotes.

Field Type Occurs Description
request complex Always The specific details for a request.

getManifest

The getManifest operation returns the manifest documents (and label documents, if requested) for all bookings based on the supplied parameters.

The response message is a getManifestResponse, and contains the manifest documents (and label documents, if requested).

If a query contains invalid data then a SoapFault is thrown with the details of the exception.

Request

getManifest request schema

<xsd:element name="getManifest">
    <xsd:complexType>
        <xsd:all>
            <xsd:element name="type" type="com:ManifestType" minOccurs="0"/>
            <xsd:element name="carrierId" type="com:CarrierId" minOccurs="0"/>
            <xsd:element name="clientId" type="com:ClientId" minOccurs="0"/>
            <xsd:element name="location" type="com:Location" minOccurs="0"/>
            <xsd:element name="readyDate" type="com:Date" minOccurs="0"/>
            <xsd:element name="lastConfirmed" type="com:YesNoOption"
           minOccurs="0"/>
            <xsd:element name="listRequests" type="com:YesNoOption"
           minOccurs="0"/>
            <xsd:element name="labelPrinterType" type="com:LabelPrinterType"
           minOccurs="0"/>
        </xsd:all>
    </xsd:complexType>
</xsd:element>

Sample getManifest request

Get manfiest and labels (for a Thermal printer) for all bookings being sent from the location ABC Suppliers, on the date 1st July, 2009.
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
        xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Header>
        <wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/04/secext">
            <wsse:UsernameToken>
                <wsse:Username>TEMANDOTEST_MANIFESTING</wsse:Username>
                <wsse:Password>temandopass1</wsse:Password>
            </wsse:UsernameToken>
        </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
        <tem:confirmManifest
          xmlns:tem="http://api-demo.temando.com/schema/2009_06/server.xsd">
            <location>Default Warehouse</location>
            <startReadyDate>2009-07-01</startReadyDate>
            <endReadyDate>2009-07-08</endReadyDate>
            <confirmedReadyDate>2009-07-01</confirmedReadyDate>
            <labelPrinterType>Thermal</labelPrinterType>
        </tem:confirmManifest>
    </soapenv:Body>
</soapenv:Envelope>

Child Content:

Field Type Occurs Description
type simple Optional The type of manifest report to be generated. Will default to “Confirmed” if no value is provided.
carrierId simple Optional The carrier’s id for returning only those bookings associated with this carrier.
clientId simple Required The client’s id for returning only those bookings associated with this client.
location simple Optional The location description for returning only those bookings associated with this location.
locationType simple Optional Whether the location description supplied references a origin or destination location.
state simple Optional To filter the manifest results to list only those consignments being delivered to the state provided.
startCode simple Optional To filter the manifest results to list only those consignments being delivered to the postal codes greater than or equal to the provided code.
endCode simple Optional To filter the manifest results to list only those consignments being delivered to the postal codes less than or equal to the provided code.
readyDate simple Required The ready date for returning only those bookings with a ready date matching this supplied date.
listRequests simple Optional Whether to return a list of request entries as data values. If no value is supplied this will default to Yes.
lastConfirmed simple Optional Whether to return only the last confirmed bookings. If Yes only the last confirmed are returned, if No then all bookings matching the supplied readyDate are returned. If no value is supplied this will default to Yes.
labelPrinterType simple Optional The type of printer that will be used for printing the item labels. If no labels required this element should not be supplied.

Further Restrictions:

Further to the restrictions applied by the field’s base type and element conditions (eg. minOccurs=“0”) the following rules will also be applied after the data has passed the XML tests:

Field Further restrictions
carrierId Only applies for users with API (Client): General access rights. Any supplied values are disregarded in all other cases.

Response

getManifest response schema

<xsd:element name="getManifestResponse">
    <xsd:complexType>
        <xsd:all>
            <xsd:element name="requests" minOccurs="0">
                <xsd:complexType>
                    <xsd:sequence>
                        <xsd:element name="request" type="com:Request" minOccurs="0"/>
                    </xsd:sequence>
                </xsd:complexType>
            </xsd:element>
            <xsd:element name="manifestDocument" type="com:ManifestDocument"/>
            <xsd:element name="manifestDocumentType"
           type="com:ManifestDocumentType"/>
            <xsd:element name="labelDocument" type="com:LabelDocument"
           minOccurs="0"/>
            <xsd:element name="labelDocumentType" type="com:LabelDocumentType"
           minOccurs="0"/>
        </xsd:all>
    </xsd:complexType>
</xsd:element>

Sample getManifest response

Requests, manifest and labels for all bookings being sent from the location ABC Suppliers, on the 1st July, 2009.
<soap-env:Envelope
        xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soap-env:Header/>
    <soap-env:Body>
        <ns1:getManifestResponse
          xmlns:ns1="http://api-demo.temando.com/schema/2009_06/server.xsd">
            <requests>
                <request id="100000">
                    <status>Completed</status>
                    <anythings>
                        <anything>
                            <class>Freight</class>
                            <mode>Less than load</mode>
                            <packaging>Carton</packaging>
                            <qualifierFreightGeneralFragile>N</qualifierFreightGeneralFragile>
                            <distanceMeasurementType>Centimetres</distanceMeasurementType>
                            <weightMeasurementType>Kilograms</weightMeasurementType>
                            <length>10</length>
                            <width>10</width>
                            <height>10</height>
                            <weight>1</weight>
                            <quantity>2</quantity>
                            <description>Contains hats.</description>
                        </anything>
                    </anythings>
                    <anywhere>
                        <itemNature>Domestic</itemNature>
                        <itemMethod>Door to Door</itemMethod>
                        <originCountry>AU</originCountry>
                        <originCode>4000</originCode>
                        <originSuburb>Brisbane</originSuburb>
                        <destinationCountry>AU</destinationCountry>
                        <destinationCode>2000</destinationCode>
                        <destinationSuburb>Sydney</destinationSuburb>
                        <destinationIs>Residence</destinationIs>
                        <destinationResPostalBox>N</destinationResPostalBox>
                        <destinationResUnattended>N</destinationResUnattended>
                        <destinationResInside>N</destinationResInside>
                        <destinationResLimitedAccess>N</destinationResLimitedAccess>
                        <destinationResHeavyLift>N</destinationResHeavyLift>
                        <originIs>Business</originIs>
                        <originBusUnattended>N</originBusUnattended>
                        <originBusDock>Y</originBusDock>
                        <originBusForklift>N</originBusForklift>
                        <originBusLoadingFacilities>N</originBusLoadingFacilities>
                        <originBusInside>N</originBusInside>
                        <originBusLimitedAccess>N</originBusLimitedAccess>
                        <originBusHeavyLift>N</originBusHeavyLift>
                        <originBusTailgateLifter>N</originBusTailgateLifter>
                        <originBusContainerSwingLifter>N</originBusContainerSwingLifter>
                    </anywhere>
                    <anytime>
                        <readyDate>2009-07-01</readyDate>
                        <readyTime>PM</readyTime>
                    </anytime>
                    <general>
                        <goodsValue>50.00</goodsValue>
                    </general>
                    <origin>
                        <description>ABC Suppliers</description>
                        <contactName>John Doe</contactName>
                        <companyName>ABC Suppliers</companyName>
                        <street>1 Originating Street</street>
                        <suburb>Brisbane</suburb>
                        <state>QLD</state>
                        <code>4000</code>
                        <country>AU</country>
                        <phone1>(07) 3333 3333</phone1>
                        <phone2/>
                        <fax>(07) 3333 3331</fax>
                        <email>bneoffice@abcsuppliers.com.au</email>
                    </origin>
                    <destination>
                        <contactName>Jane Doe</contactName>
                        <street>2 Recipient Street</street>
                        <suburb>Sydney</suburb>
                        <state>NSW</state>
                        <code>2000</code>
                        <country>AU</country>
                        <phone1>(02) 9333 3333</phone1>
                        <phone2/>
                        <fax>(02) 9333 3331</fax>
                        <email>jane.doe@yahoo.com.au</email>
                    </destination>
                    <quotes>
                        <quote>
                            <generated>Automatically</generated>
                            <accepted>Y</accepted>
                            <bookingNumber>XYZ300001</bookingNumber>
                            <consignmentNumber>UVW400001</consignmentNumber>
                            <trackingStatus>In Transit</trackingStatus>
                            <trackingStatusOccurred>2009-07-02T15:25:46Z
                            </trackingStatusOccurred>
                            <trackingLastChecked>2009-07-02T18:13:12Z</trackingLastChecked>
                            <trackingFurtherDetails/>
                            <totalPrice>11.00</totalPrice>
                            <basePrice>10.00</basePrice>
                            <tax>1.00</tax>
                            <currency>AUD</currency>
                            <deliveryMethod>Off-peak</deliveryMethod>
                            <usingGeneralRail>N</usingGeneralRail>
                            <usingGeneralRoad>Y</usingGeneralRoad>
                            <usingGeneralSea>N</usingGeneralSea>
                            <usingExpressAir>N</usingExpressAir>
                            <usingExpressRoad>N</usingExpressRoad>
                            <etaFrom>2</etaFrom>
                            <etaTo>3</etaTo>
                            <guaranteedEta>Y</guaranteedEta>
                            <adjustments>
                                <adjustment>
                                    <description>Credit Card Payment Adjustment</description>
                                    <amount>0.20</amount>
                                    <tax>0.02</tax>
                                </adjustment>
                                <adjustment>
                                    <description>Credit Payment Adjustment</description>
                                    <amount>-0.20</amount>
                                    <tax>-0.02</tax>
                                </adjustment>
                            </adjustments>
                            <inclusions>
                                <inclusion>
                                    <summary>Tracking available</summary>
                                    <details>Tracking information will be available for this quote.
                                    </details>
                                </inclusion>
                                <inclusion>
                                    <summary>Automatic Booking</summary>
                                    <details>Automatic booking generated.</details>
                                </inclusion>
                                <inclusion>
                                    <summary>Automatic Consignment</summary>
                                    <details>Automatic consignment note generated.</details>
                                </inclusion>
                            </inclusions>
                            <extras>
                                <extra>
                                    <summary>Insurance</summary>
                                    <details>Insurance cover up to $5,000.</details>
                                    <totalPrice>2.20</totalPrice>
                                    <basePrice>2.00</basePrice>
                                    <tax>0.20</tax>
                                    <mandatory>Y</mandatory>
                                    <adjustments>
                                        <adjustment>
                                            <description>Credit Card Payment Adjustment</description>
                                            <amount>0.04</amount>
                                            <tax>0.00</tax>
                                        </adjustment>
                                    </adjustments>
                                </extra>
                            </extras>
                            <carrier>
                                <id>654321</id>
                                <companyName>ZYX Transport</companyName>
                                <companyContact>John Doe</companyContact>
                                <streetAddress>1 Transport Street</streetAddress>
                                <streetSuburb>Brisbane</streetSuburb>
                                <streetCity>Brisbane</streetCity>
                                <streetState>QLD</streetState>
                                <streetCode>4000</streetCode>
                                <streetCountry>AU</streetCountry>
                                <postalAddress>PO Box 1111</postalAddress>
                                <postalSuburb>Brisbane</postalSuburb>
                                <postalCity>Brisbane</postalCity>
                                <postalState>QLD</postalState>
                                <postalCode>4001</postalCode>
                                <postalCountry>AU</postalCountry>
                                <phone1>(07) 3333 3333</phone1>
                                <email>john.doe@zyxtransport.com.au</email>
                                <website>https://www.zyxtransport.com.au</website>
                                <conditions>Our conditions include: lots of text.</conditions>
                            </carrier>
                        </quote>
                    </quotes>
                    <instructions>Please use side door.</instructions>
                    <reference>ABC200000</reference>
                    <comments>Please don't use any chains on the axle.</comments>
                </request>
            </requests>
            <consignmentDocument>JVBER … shortened for readability … XRhbG</consignmentDocument>
            <consignmentDocumentType>application/pdf</consignmentDocumentType>
            <labelDocument>e3Rf3 … shortened for readability … X8ggy</labelDocument>
            <labelDocumentType>application/pdf</labelDocumentType>
        </ns1:getManifestResponse>
    </soap-env:Body>
</soap-env:Envelope>

Child Content:

The details relating to the associated requests, manifest documents and label documents.

Field Type Occurs Description
requests list Optional A list of corresponding requests.
manifestNumber simple Optional The carrier’s manifest number identifies a logical grouping of consignments. This is optional as the carrier may not require this, a number has not yet been assigned (ie. request has not been confirmed for manifesting) or multiple manifest documents are being produced.
manifestDocument simple Always The manifest document. Important: The contents of this field are encoded using base64. This is done to ensure that the binary data that forms the file’s contents survive transport through the transport layer. When creating a file from this field’s contents you will need to ensure that you decode using base64.
manifestDocumentType simple Optional The type of the manifest document.
labelDocument simple Optional The label document. This will only be provided if a value was provided for the labelPrinterType element. Important: The contents of this field are encoded using base64. This is done to ensure that the binary data that forms the file’s contents survive transport through the transport layer. When creating a file from this field’s contents you will need to ensure that you decode using base64.
labelDocumentType simple Optional The type of the label document. This will only be provided if a value was provided for the labelPrinterType element.

confirmManifest

The confirmManifest operation registers those requests that match the supplied parameters as being confirmed and ready to send. If a confirmedReadyDate is supplied all matching requests are updated to have this new send date.

The response message is a confirmManifestResponse, and contains the manifest documents (and label documents, if requested).

If a query contains invalid data then a SoapFault is thrown with the details of the exception.

Request

confirmManifest request schema

<xsd:element name="confirmManifest">
    <xsd:complexType>
        <xsd:all>
            <xsd:element name="carrierId" type="com:CarrierId" minOccurs="0"/>
            <xsd:element name="clientId" type="com:ClientId" minOccurs="0"/>
            <xsd:element name="location" type="com:Location" minOccurs="0"/>
            <xsd:element name="startReadyDate" type="com:Date" minOccurs="0"/>
            <xsd:element name="endReadyDate" type="com:Date" minOccurs="0"/>
            <xsd:element name="confirmedReadyDate" type="com:Date" minOccurs="0"/>
            <xsd:element name="listRequests" type="com:YesNoOption"
           minOccurs="0"/>
            <xsd:element name="labelPrinterType" type="com:LabelPrinterType"
           minOccurs="0"/>
        </xsd:all>
    </xsd:complexType>
</xsd:element>

Sample confirmManifest request

Confirm all bookings being sent from the location ABC Suppliers, between (and included) the dates 1st July, 2009 and 3rd July, 2009.  Also update the send date for all bookings to the 1st July, 2009.
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope
        xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Header>
        <wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/04/secext">
            <wsse:UsernameToken>
                <wsse:Username>username</wsse:Username>
                <wsse:Password>password</wsse:Password>
            </wsse:UsernameToken>
        </wsse:Security>
    </soapenv:Header>
    <soapenv:Body>
        <tem:confirmManifest
          xmlns:tem="http://api-demo.temando.com/schema/2009_06/server.xsd">
            <location>ABC Suppliers</location>
            <startReadyDate>2009-07-01</startReadyDate>
            <endReadyDate>2009-07-03</endReadyDate>
            <confirmedReadyDate>2009-07-01</confirmedReadyDate>
            <labelPrinterType>Thermal</labelPrinterType>
        </tem:confirmManifest>
    </soapenv:Body>
</soapenv:Envelope>

Child Content:

Field Type Occurs Description
carrierId simple Optional The carrier’s id for confirming only those bookings associated with this carrier.
clientId simple Required The client’s id for confirming only those bookings associated with this client.
location simple Required The location description for confirming only those bookings associated with this location.
locationType simple Optional Whether the location description supplied references a origin or destination location.
state simple Optional To filter the manifest results to list only those consignments being delivered to the state provided.
startCode simple Optional To filter the manifest results to list only those consignments being delivered to the postal codes greater than or equal to the provided code.
endCode simple Optional To filter the manifest results to list only those consignments being delivered to the postal codes less than or equal to the provided code.
startReadyDate simple Optional The start ready date for confirming only those bookings with a ready date after (and including) this supplied date.
endReadyDate simple Optional The end ready date for confirming only those bookings with a ready date before (and including) this supplied date.
confirmedReadyDate simple Optional The ready date that all matching bookings will be updated to.
listRequests simple Optional Whether to return a list of request entries as data values.
labelPrinterType simple Optional The type of printer that will be used for printing the item labels. If no labels required this element should not be supplied.

Response

confirmManifest response schema

<xsd:element name="confirmManifestResponse">
    <xsd:complexType>
        <xsd:all>
            <xsd:element name="requests" minOccurs="0">
                <xsd:complexType>
                    <xsd:sequence>
                        <xsd:element name="request" type="com:Request" minOccurs="0"/>
                    </xsd:sequence>
                </xsd:complexType>
            </xsd:element>
            <xsd:element name="manifestDocument" type="com:ManifestDocument"/>
            <xsd:element name="manifestDocumentType"
           type="com:ManifestDocumentType"/>
            <xsd:element name="labelDocument" type="com:LabelDocument"
           minOccurs="0"/>
            <xsd:element name="labelDocumentType" type="com:LabelDocumentType"
           minOccurs="0"/>
        </xsd:all>
    </xsd:complexType>
</xsd:element>

Sample confirmManifest response

Requests, manfiest and labels for all bookings being sent from the location ABC Suppliers, on the 1st July, 2009.
<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope
        xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soap-env:Header/>
    <soap-env:Body>
        <ns1:confirmManifestResponse
          xmlns:ns1="http://api-demo.temando.com/schema/2009_06/server.xsd">
            <requests>
                <request id="100000">
                    <status>Completed</status>
                    <anythings>
                        <anything>
                            <class>Freight</class>
                            <mode>Less than load</mode>
                            <packaging>Carton</packaging>
                            <qualifierFreightGeneralFragile>N</qualifierFreightGeneralFragile>
                            <distanceMeasurementType>Centimetres</distanceMeasurementType>
                            <weightMeasurementType>Kilograms</weightMeasurementType>
                            <length>10</length>
                            <width>10</width>
                            <height>10</height>
                            <weight>1</weight>
                            <quantity>2</quantity>
                            <description>Contains hats.</description>
                        </anything>
                    </anythings>
                    <anywhere>
                        <itemNature>Domestic</itemNature>
                        <itemMethod>Door to Door</itemMethod>
                        <originCountry>AU</originCountry>
                        <originCode>4000</originCode>
                        <originSuburb>Brisbane</originSuburb>
                        <destinationCountry>AU</destinationCountry>
                        <destinationCode>2000</destinationCode>
                        <destinationSuburb>Sydney</destinationSuburb>
                        <destinationIs>Residence</destinationIs>
                        <destinationResPostalBox>N</destinationResPostalBox>
                        <destinationResUnattended>N</destinationResUnattended>
                        <destinationResInside>N</destinationResInside>
                        <destinationResLimitedAccess>N</destinationResLimitedAccess>
                        <destinationResHeavyLift>N</destinationResHeavyLift>
                        <originIs>Business</originIs>
                        <originBusUnattended>N</originBusUnattended>
                        <originBusDock>Y</originBusDock>
                        <originBusForklift>N</originBusForklift>
                        <originBusLoadingFacilities>N</originBusLoadingFacilities>
                        <originBusInside>N</originBusInside>
                        <originBusLimitedAccess>N</originBusLimitedAccess>
                        <originBusHeavyLift>N</originBusHeavyLift>
                        <originBusTailgateLifter>N</originBusTailgateLifter>
                        <originBusContainerSwingLifter>N</originBusContainerSwingLifter>
                    </anywhere>
                    <anytime>
                        <readyDate>2009-07-01</readyDate>
                        <readyTime>PM</readyTime>
                    </anytime>
                    <general>
                        <goodsValue>50.00</goodsValue>
                    </general>
                    <origin>
                        <description>ABC Suppliers</description>
                        <contactName>John Doe</contactName>
                        <companyName>ABC Suppliers</companyName>
                        <street>1 Originating Street</street>
                        <suburb>Brisbane</suburb>
                        <state>QLD</state>
                        <code>4000</code>
                        <country>AU</country>
                        <phone1>(07) 3333 3333</phone1>
                        <phone2/>
                        <fax>(07) 3333 3331</fax>
                        <email>bneoffice@abcsuppliers.com.au</email>
                    </origin>
                    <destination>
                        <contactName>Jane Doe</contactName>
                        <street>2 Recipient Street</street>
                        <suburb>Sydney</suburb>
                        <state>NSW</state>
                        <code>2000</code>
                        <country>AU</country>
                        <phone1>(02) 9333 3333</phone1>
                        <phone2/>
                        <fax>(02) 9333 3331</fax>
                        <email>jane.doe@yahoo.com.au</email>
                    </destination>
                    <quotes>
                        <quote>
                            <generated>Automatically</generated>
                            <accepted>Y</accepted>
                            <bookingNumber>XYZ300001</bookingNumber>
                            <consignmentNumber>UVW400001</consignmentNumber>
                            <trackingStatus>In Transit</trackingStatus>
                            <trackingStatusOccurred>2009-07-02T15:25:46Z
                            </trackingStatusOccurred>
                            <trackingLastChecked>2009-07-02T18:13:12Z</trackingLastChecked>
                            <trackingFurtherDetails/>
                            <totalPrice>11.00</totalPrice>
                            <basePrice>10.00</basePrice>
                            <tax>1.00</tax>
                            <currency>AUD</currency>
                            <deliveryMethod>Off-peak</deliveryMethod>
                            <usingGeneralRail>N</usingGeneralRail>
                            <usingGeneralRoad>Y</usingGeneralRoad>
                            <usingGeneralSea>N</usingGeneralSea>
                            <usingExpressAir>N</usingExpressAir>
                            <usingExpressRoad>N</usingExpressRoad>
                            <etaFrom>2</etaFrom>
                            <etaTo>3</etaTo>
                            <guaranteedEta>Y</guaranteedEta>
                            <adjustments>
                                <adjustment>
                                    <description>Credit Card Payment Adjustment</description>
                                    <amount>0.20</amount>
                                    <tax>0.02</tax>
                                </adjustment>
                                <adjustment>
                                    <description>Credit Payment Adjustment</description>
                                    <amount>-0.20</amount>
                                    <tax>-0.02</tax>
                                </adjustment>
                            </adjustments>
                            <inclusions>
                                <inclusion>
                                    <summary>Tracking available</summary>
                                    <details>Tracking information will be available for this quote.
                                    </details>
                                </inclusion>
                                <inclusion>
                                    <summary>Automatic Booking</summary>
                                    <details>Automatic booking generated.</details>
                                </inclusion>
                                <inclusion>
                                    <summary>Automatic Consignment</summary>
                                    <details>Automatic consignment note generated.</details>
                                </inclusion>
                            </inclusions>
                            <extras>
                                <extra>
                                    <summary>Insurance</summary>
                                    <details>Insurance cover up to $5,000.</details>
                                    <totalPrice>2.20</totalPrice>
                                    <basePrice>2.00</basePrice>
                                    <tax>0.20</tax>
                                    <mandatory>Y</mandatory>
                                    <adjustments>
                                        <adjustment>
                                            <description>Credit Card Payment Adjustment</description>
                                            <amount>0.04</amount>
                                            <tax>0.00</tax>
                                        </adjustment>
                                    </adjustments>
                                </extra>
                            </extras>
                            <carrier>
                                <id>654321</id>
                                <companyName>ZYX Transport</companyName>
                                <companyContact>John Doe</companyContact>
                                <streetAddress>1 Transport Street</streetAddress>
                                <streetSuburb>Brisbane</streetSuburb>
                                <streetCity>Brisbane</streetCity>
                                <streetState>QLD</streetState>
                                <streetCode>4000</streetCode>
                                <streetCountry>AU</streetCountry>
                                <postalAddress>PO Box 1111</postalAddress>
                                <postalSuburb>Brisbane</postalSuburb>
                                <postalCity>Brisbane</postalCity>
                                <postalState>QLD</postalState>
                                <postalCode>4001</postalCode>
                                <postalCountry>AU</postalCountry>
                                <phone1>(07) 3333 3333</phone1>
                                <email>john.doe@zyxtransport.com.au</email>
                                <website>https://www.zyxtransport.com.au</website>
                                <conditions>Our conditions include: lots of text.</conditions>
                            </carrier>
                        </quote>
                    </quotes>
                    <instructions>Please use side door.</instructions>
                    <reference>ABC200000</reference>
                    <comments>Please don't use any chains on the axle.</comments>
                </request>
            </requests>
            <consignmentDocument>JVBER … shortened for readability … XRhbG</consignmentDocument>
            <consignmentDocumentType>application/pdf</consignmentDocumentType>
            <labelDocument>e3Rf3 … shortened for readability … X8ggy</labelDocument>
            <labelDocumentType>application/pdf</labelDocumentType>
        </ns1:confirmManifestResponse>
    </soap-env:Body>
</soap-env:Envelope>

Child Content:

The details relating to the associated requests, manifest documents and label documents.

Field Type Occurs Description
requests list Optional A list of corresponding requests.
manifests list Optional The list of all manifest details (eg. number, carrier, etc) for the corresponding document.
manifestDocument simple Always The manifest document. Important: The contents of this field are encoded using base64. This is done to ensure that the binary data that forms the file’s contents survive transport through the transport layer. When creating a file from this field’s contents you will need to ensure that you decode using base64.
manifestDocumentType simple Always The type of the manifest document.
labelDocument simple Optional The label document. This will only be provided if a value was provided for the labelPrinterType element. Important: The contents of this field are encoded using base64. This is done to ensure that the binary data that forms the file’s contents survive transport through the transport layer. When creating a file from this field’s contents you will need to ensure that you decode using base64.
labelDocumentType simple Optional The type of the label document. This will only be provided if a value was provided for the labelPrinterType element.

Complex Data Types

Adjustment

Sample Adjustment XML

<adjustment xsi:type=“com:Adjustment”>
    <description>Credit Payment Adjustment</description>
    <amount>-0.40</amount>
    <tax>-0.04</tax>
</adjustment>

Specific details about an adjustment. An adjustment is a set of values (ie. amount and tax) that are either added (postitive values) or deducted (negative values) from a quote, if the condition for applying the adjustment occurs.

Field Type Occurs Description
description simple Required A description of the adjustment.
amount simple Required The amount of the adjustment, excluding any tax.
tax simple Required The tax amount of the adjustment.

Used in AvailableQuote.

Back

Anything

Sample Anything XML

<anything xsi:type=”com:Anything”>
    <class>Freight</class>
    <mode>Less than load</mode>
    <packaging>Carton</packaging>
    <qualifierFreightGeneralFragile>N</qualifierFreightGeneralFragile>
    <distanceMeasurementType>Centimetres</distanceMeasurementType>
    <weightMeasurementType>Kilograms</weightMeasurementType>
    <length>10</length>
    <width>10</width>
    <height>10</height>
    <weight>1</weight>
    <quantity>2</quantity>
    <description>Contains hats.</description>
</anything>

The specific details about an item being sent.

Field Type Occurs Description
class simple Required The class of the item being sent.
quantity simple Required The number of items being sent.
subclass simple Optional* The subclass of the item being sent.
mode simple Optional* The mode of the item being sent.
tlSubclass simple Optional* The start ready date for confirming only those bookings with a ready date after (and including) this supplied date.
packaging simple Optional* The end ready date for confirming only those bookings with a ready date before (and including) this supplied date.
packagingOptimisation simple Optional* Whether the supplied anything details should be used to find an optimal package solution.
palletType simple Optional* The pallet type being sent.
palletNature simple Optional* The pallet nature being sent.
containerDimensions simple Optional* The dimensions of the container being sent.
containerNature simple Optional* The nature of the container being sent.
containerRegistered simple Optional* Whether the container is registered.
qualifierFreightGeneralFragile simple Optional* If the item being sent is fragile.
qualifierVehicleMake simple Optional* The make of the vehicle being sent.
qualifierVehicleModel simple Optional* The model of the vehicle being sent.
qualifierVehicleDescription simple Optional* The description of the vehicle being sent.
qualifierVehicleYear simple Optional* The year of the vehicle being sent.
qualifierVehicleRunning simple Optional* If the vehicle being sent is running.
qualifierVehicleRegistered simple Optional* If the vehicle being sent is registered.
qualifierVehicleRegistration simple Optional* The registration of the vehicle being sent.
length simple Optional* The length of the item being sent.
width simple Optional* The width of the item being sent.
height simple Optional* The height of the item being sent.
weight simple Optional* The weight of the item being sent.
distanceMeasurementType simple Optional* The distance measurement type to be used for the Length, Width and height values.
weightMeasurementType simple Optional* The weight measurement type to be used for the Weight values.
description simple Optional* Further details of the item being sent, that have not been specified in other elements.
dangerousGoodsPackagingGroup simple Optional* The dangerous goods packaging group for the items being sent.d
dangerousGoodsClass simple Optional* The dangerous goods class for the item being sent.
unNumbers simple Optional* The UN number for the material of the item being sent.
articles simple Optional* The details about the individual items being sent.

Further Restrictions:

Further to the restrictions applied by the field’s base type and element conditions (eg. minOccurs=“0”), the following rules will also be applied after the data has passed the XML tests:

Field Further restrictions
subclass Applies (and is mandatory) only if:
  • class is General Goods, Vehicle, Boat, Animal, Refrigerated or Other.
Values will be limited in the following cases:
  • If class is General Goods options are limited to: Household Goods, Excess Baggage, Furniture, or Other (Etc.).
  • If class is Vehicle, options are limited to: Car, Motorcycle, Tractor, Equipment, or Other (Etc.).
mode Applies (and is mandatory) only if:
  • class is Freight
tlSubclass Applies (and is mandatory) only if:
  • mode is Truckload
packaging Applies (and is mandatory) only if:
  • class is General Goods or Other.
  • class is Freight and mode is Less than load.
Values will be limited in the following cases:
  • If class is General Goods and mode is Household Goods, options are limited to: Box, Carton, Crate, Cylinder, Document Envelope, Flat Pack, Letter, Pallet, Parcel, Satchel/Bag, Skid, Unpackaged or N/A, or Wheel/Tyre.
  • If class is General Goods and mode is Excess Baggage, options are limited to: Backpack, Box, Carton or Suitcase.
  • If class is General Goods and mode is Excess Furniture, options are limited to: Box, Carton, Crate, Flat Pack, Pallet, Skid or Unpackaged or N/A.
  • If class is General Goods and mode is Other (Etc.), options are limited to: Box, Carton, Crate, Cylinder, Document Envelope, Flat Pack, Letter, Pallet, Parcel, Pipe, Satchel/Bag, Skid, Tube, Unpackaged or N/A, or Wheel/Tyre.
  • If class is Other, options are limited to: Bale, Box, Bunch, Bundle, Carton, Crate, Cylinder, Document Envelope, Drum, Flat Pack, Letter, Pail, Pallet, Parcel, Pipe, Roll, Satchel/Bag, Skid, Suitcase, Tube, Unpackaged or N/A, or Wheel/Tyre
  • If class is Freight and mode is Less than load, options are limited to: Bale, Box, Bunch, Bundle, Carton, Crate, Cylinder, Document Envelope, Drum, Flat Pack, Letter, Pail, Pallet, Parcel, Pipe, Roll, Satchel/Bag, Skid, Suitcase, Tube, or Wheel/Tyre.
palletType Applies (and is mandatory) only if:
  • class is Refrigerated
  • packaging is Pallet
  • mode is Truckload.
palletNature Applies (and is mandatory) only if:
  • class is Refrigerated
  • packaging is Pallet
  • mode is Truckload.
containerDimensions Applies (and is mandatory) only if:
  • mode is Container.
containerNature Applies (and is mandatory) only if:
  • mode is Container.
containerRegistered Applies (and is mandatory) only if:
  • mode is Container.
qualifierFreightGeneralFragile Applies (and is mandatory) only if:
  • mode is Container.
qualifierVehicleMake Applies (and is mandatory) only if:
  • class is Vehicle
Values will be limited in the following cases:
  • If subclass is Car, must match exactly (ie. letter for letter but not case sensitive) with a Make defined within the Temando system.
qualifierVehicleModel Applies (and is mandatory) only if:
  • class is Vehicle
Values will be limited in the following cases:
  • If subclass is Car, must match exactly (ie. letter for letter but not case sensitive) with a Make defined within the Temando system.
qualifierVehicleDescription Applies (and is mandatory) only if:
  • class is Vehicle
Values will be limited in the following cases:
  • If subclass is Car, must match exactly (ie. letter for letter but not case sensitive) with a Make defined within the Temando system.
qualifierVehicleYear Applies (and is mandatory) only if:
  • class is Vehicle
Values will be limited in the following cases:
  • If subclass is Car, must match exactly (ie. letter for letter but not case sensitive) with a Make defined within the Temando system.
qualifierVehicleRunning Applies (and is mandatory) only if:
  • class is Vehicle.
qualifierVehicleRegistered Applies (and is mandatory) only if:
  • class is Vehicle.
qualifierVehicleRegistration Applies (and is mandatory) only if:
  • class is Vehicle.
length Applies (and is mandatory) only if:
  • class is General Goods, Boat, Refrigerated or Other
  • class is Freight and mode is Less than load
  • class is Vehicle and subclass is Tractor, Equipment or Other (Etc.).
width Applies (and is mandatory) only if:
  • class is General Goods, Boat, Refrigerated or Other
  • class is Freight and mode is Less than load
  • class is Vehicle and subclass is Tractor, Equipment or Other (Etc.).
height Applies (and is mandatory) only if:
  • class is General Goods, Boat, Refrigerated or Other
  • class is Freight and mode is Less than load
  • class is Vehicle and subclass is Tractor, Equipment or Other (Etc.).
weight Applies (and is mandatory) only if:
  • class is Freight, General Goods, Animal, Boat, Refrigerated or Other
  • class is Vehicle and subclass is Tractor, Equipment or Other (Etc.).
distanceMeasurementType Applies (and is mandatory) only if:
  • class is General Goods, Boat, Refrigerated or Other
  • class is Freight and mode is Less than load
  • class is Vehicle and subclass is Tractor, Equipment or Other (Etc.).
weightMeasurementType Applies (and is mandatory) only if:
  • class is Freight, General Goods, Animal, Boat, Refrigerated or Other
  • class is Vehicle and subclass is Tractor, Equipment or Other (Etc.).
description Applies (and is mandatory) only if:
  • class is Freight, General Goods, or Refrigerated.
dangerousGoodsPackagingGroup Applies (and is mandatory) only if:
  • delivery is an international delivery.
dangerousGoodsClass Applies (and is mandatory) only if:
  • delivery is an international delivery.
unNumbers Applies (and is mandatory) only if:
  • delivery is an international delivery.

Used in getQuotes and makeBooking.

Back

Anytime

Sample Anytime XML

<anytime xsi:type=“com:Anytime”>
    <readyDate>2009-07-01</readyDate>
    <readyTime>PM</readyTime>
</anytime>

The specific details about when items are being sent.

Field Type Occurs Description
readyDate simple Required What date is the item ready to be sent?
readyTime simple Required What time is the item ready to be sent?

Used in getQuotes and makeBooking.

Back

Anywhere

Sample Anywhere XML

<anywhere xsi:type=“com:Anywhere”>
    <itemNature>Domestic</itemNature>
    <itemMethod>Door to Door</itemMethod>
    <originCountry>AU</originCountry>
    <originCode>4000</originCode>
    <originSuburb>Brisbane</originSuburb>
    <destinationCountry>AU</destinationCountry>
    <destinationCode>2000</destinationCode>
    <destinationSuburb>Sydney</destinationSuburb>
    <destinationIs>Residence</destinationIs>
    <destinationResNotifyBefore>N</destinationResNotifyBefore>
    <destinationResLimitedAccess>N</destinationResLimitedAccess>
    <originIs>Business</originIs>
    <originBusNotifyBefore>Y</originBusNotifyBefore>
    <originBusLimitedAccess>N</originBusLimitedAccess>
</anywhere>

The specific details about where items are being sent.

Field Type Occurs Description
itemNature simple Required Whether the item is being sent domestically (ie. within the same country) or internationally (from one country to another).
itemMethod simple Required* The delivery method for the item being sent. Current implementation only supports Door to Door and Depot to Depot (does not support Port to Port).
originDescription simple Optional A description allocated to a predefined location stored in the client’s location listings.
originCountry simple Optional* The country that the item is being sent from (international) or within (domestic).
originCode simple Optional* The postal code of the location that the item is being sent from.
originSuburb simple Optional* The suburb of the location that the item is being sent from.
originState simple Optional* The state of the location that the item is being sent from.
originCity simple Optional* The city or town of the location that the item is being sent from.
destinationDescription simple Optional A description allocated to a predefined location stored in the client’s location listings.
destinationCountry simple Optional* The country that the item is being sent to (international) or within (domestic).
destinationCode simple Optional* The postal code of the location that the item is being sent to.
destinationSuburb simple Optional* The suburb of the location that the item is being sent to.
destinationState simple Optional* The state of the location that the item is being sent to.
destinationCity simple Optional* The city or town of the location that the item is being sent to.
destinationIs simple Optional* What type of location is receiving the item.
destinationBusPostalBox simple Optional* Is the receiving location a postal box?
destinationBusUnattended simple Optional* Will the receiving location be unattended?
destinationBusDock simple Optional* Does the receiving location have a dock?
destinationBusForklift simple Optional* Does the receiving location have forklift?
destinationBusLoadingFacilities simple Optional* Does the receiving location have loading facilities?
destinationBusInside simple Optional* Does the receiving location require an inside pickup?
destinationBusLimitedAccess simple Optional* Does the receiving location have limited access?
destinationBusHeavyLift simple Optional* Will the item be a heavy lift?
destinationBusContainerSwingLifter simple Optional* Does the receiving location require a container swing lifter?
destinationResPostalBox simple Optional* Is the receiving location a postal box?
destinationResUnattended simple Optional* Will the receiving location be unattended?
destinationResInside simple Optional* Does the receiving location require an inside pickup?
destinationResLimitedAccess simple Optional* Does the receiving location have limited access?
destinationResHeavyLift simple Optional* Will the item be a heavy lift?
originIs simple Optional* What type of location is sending the item.
originBusUnattended simple Optional* Will the sending location be unattended?
originBusDock simple Optional* Does the sending location have a dock?
originBusForklift simple Optional* Does the sending location have forklift?
originBusLoadingFacilities simple Optional* Does the sending location have loading facilities?
originBusInside simple Optional* Does the sending location require an inside pickup?
originBusLimitedAccess simple Optional* Does the sending location have limited access?
originBusHeavyLift simple Optional* Will the item be a heavy lift?
originBusContainerSwingLifter simple Optional* Does the sending location require a container swing lifter?
originResUnattended simple Optional* Will the sending location be unattended?
originResInside simple Optional* Does the sending location require an inside pickup?
originResLimitedAccess simple Optional* Does the sending location have limited access?
originResHeavyLift simple Optional* Will the item be a heavy lift?
locationSelection simple Optional If an origin location is not specified this element specifies how the origin should be selected.

Further Restrictions:

Further to the restrictions applied by the field’s base type and element conditions (eg. minOccurs=“0”), the following rules will also be applied after the data has passed the XML tests:

Field Further restrictions
itemMethod Values will be limited in the following cases:
  • If itemNature is Domestic, options are limited to: Door to Door or Depot to Depot.
  • If itemNature is International, options are limited to: Door to Door or Port to Port.
originCountry Applies (and is mandatory) only if:
  • originDescription is not supplied.
originCode Applies (and is mandatory) only if:
  • itemNature is Domestic and itemMethod is Door to Door.
  • itemNature is International and itemMethod is Door to Door.
  • originDescription is not supplied.
originSuburb Applies (and is mandatory) only if:
  • itemNature is Domestic and itemMethod is Door to Door.
  • itemNature is International and itemMethod is Door to Door.
  • originDescription is not supplied.
originState Applies (and is mandatory) only if:
  • itemNature is Domestic and itemMethod is Door to Door.
  • itemNature is International and itemMethod is Door to Door.
  • originDescription is not supplied.
originCity Applies (and is mandatory) only if:
  • itemNature is Domestic and itemMethod is Door to Door.
  • itemNature is International and itemMethod is Door to Door.
  • originDescription is not supplied.
destinationCountry Applies (and is mandatory) only if:
  • destinationDescription is not supplied.
destinationCode Applies (and is mandatory) only if:
  • itemNature is Domestic and itemMethod is Door to Door.
  • itemNature is International and itemMethod is Door to Door.
  • destinationDescription is not supplied.
destinationSuburb Applies (and is mandatory) only if:
  • itemNature is Domestic and itemMethod is Door to Door.
  • itemNature is International and itemMethod is Door to Door.
  • destinationDescription is not supplied.
destinationState Applies (and is mandatory) only if:
  • itemNature is Domestic and itemMethod is Door to Door.
  • itemNature is International and itemMethod is Door to Door.
  • destinationDescription is not supplied.
destinationCity Applies (and is mandatory) only if:
  • itemNature is Domestic and itemMethod is Door to Door.
  • itemNature is International and itemMethod is Door to Door.
  • destinationDescription is not supplied.
destinationIs Applies (and is mandatory) only if:
  • itemMethod is Door to Door and destinationDescription is not supplied.
destinationBusPostalBox Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Business, class is Freight, General Goods or Other, and destinationDescription is not supplied.
destinationBusUnattended Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Business and class is Freight, General Goods or Other.
destinationBusDock Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Business, class is Freight, General Goods, Animal, Refrigerated or Other, and destinationDescription is not supplied.
destinationBusForklift Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Business, class is Freight, General Goods, Animal, Refrigerated or Other, and destinationDescription is not supplied.
destinationBusLoadingFacilities Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Business, class is Boat, and destinationDescription is not supplied.
destinationBusInside Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Business, class is Freight, General Goods, Animal, Refrigerated or Other.
destinationBusLimitedAccess Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Business, class is Freight, General Goods, Vehicle, Boat, Animal, Refrigerated or Other, and destinationDescription is not supplied.
destinationBusHeavyLift Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Business, and class is General Goods, Boat, Animal, Refrigerated or Other.
destinationBusContainerSwingLifter Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Business, and class is Freight.
destinationResPostalBox Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Residence, class is Freight, General Goods, or Other, and destinationDescription is not supplied.
destinationResUnattended Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Residence, and class is Freight, General Goods, or Other.
destinationResInside Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Residence, and class is Freight, General Goods, Animal, Refrigerated, or Other.
destinationResLimitedAccess Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Residence, class is Freight, General Goods, Vehicle, Boat, Animal, Refrigerated, or Other, and destinationDescription is not supplied.
destinationResHeavyLift Applies (and is mandatory) only if:
  • itemMethod is Door to Door, destinationIs is Residence, and class is General Goods, Boat, Animal, Refrigerated, or Other.
originIs Applies (and is mandatory) only if:
  • itemMethod is Door to Door, and originDescription is not supplied.
originBusUnattended Applies (and is mandatory) only if:
  • itemMethod is Door to Door, originIs is Business, and class is Freight, General Goods, or Other.
originBusDock Applies (and is mandatory) only if:
  • itemMethod is Door to Door, originIs is Business, class is Freight, General Goods, Animal, Refrigerated, or Other, and originDescription is not supplied.
originBusForklift Applies (and is mandatory) only if:
  • itemMethod is Door to Door, originIs is Business, class is Freight, General Goods, Animal, Refrigerated, or Other, and originDescription is not supplied.
originBusLoadingFacilities Applies (and is mandatory) only if:
  • itemMethod is Door to Door, originIs is Business, class is Boat, and originDescription is not supplied.
originBusInside Applies (and is mandatory) only if:
  • itemMethod is Door to Door, originIs is Business, and class is Freight, General Goods, Animal, Refrigerated, or Other.
originBusLimitedAccess Applies (and is mandatory) only if:
  • itemMethod is Door to Door, originIs is Business, class is Freight, General Goods, Vehicle, Boat, Animal, Refrigerated, or Other, and originDescription is not supplied.
originBusHeavyLift Applies (and is mandatory) only if:
  • itemMethod is Door to Door, originIs is Business, and class is General Goods, Boat, Animal, Refrigerated, or Other.
originBusContainerSwingLifter Applies (and is mandatory) only if:
  • itemMethod is Door to Door, originIs is Business, and class is Freight.
originResUnattended Applies (and is mandatory) only if:
  • itemMethod is Door to Door, originIs is Residence, and class is Freight, General Goods, or Other.
originResInside Applies (and is mandatory) only if:
  • itemMethod is Door to Door, originIs is Residence, and class is Freight, General Goods, Animal, Refrigerated, or Other.
originResLimitedAccess Applies (and is mandatory) only if:
  • itemMethod is Door to Door, originIs is Residence, and class is Freight, General Goods, Vehicle, Boat, Animal, Refrigerated, or Other.
originResHeavyLift Applies (and is mandatory) only if:
  • itemMethod is Door to Door, originIs is Residence, and class is General Goods, Boat, Animal, or Other.

Used in getQuotes and makeBooking.

Back

Article

Sample Article XML

<article xsi:type=”com:Article”>
    <articleId>123456</articleId>
    <anythingIndex>1</anythingIndex>
    <articleNumber>GHI000001</articleNumber>
    <sku>123456789</sku>
    <countryOfOrigin>AU</countryOfOrigin>
    <countryOfManufacture>CH</countryOfManufacture>
    <composition>50% cotton, 50% polyester</composition>
    <goodsValue>200</goodsValue>
    <goodsCurrency>AUD</goodsCurrency>
</article>

The article details of the consignment.

Field Type Occurs Description
articleId simple Requried The article id
anythingIndex simple Required The anything index for a request.
articleNumber simple Required The article number associated with an individual item.
labelDocument simple Optional The carrier’s label document. This is optional as the carrier may not provide a document. Important: The contents of this field are encoded using base64. This is done to ensure that the binary data that forms the file’s contents survive transport through the transport layer. When creating a file from this field’s contents you will need to ensure that you decode using base64.
labelDocumentType simple Optional The type of the carrier’s label document. This is only provided if an entry for the labelDocument field is provided.
description simple Optional The description for the individual item.
sku simple Optional The SKU for the individual item.
sscc simple Optional The SSCC for the individual item.
hs simple Optional The HS for the individual item.
hs6Digit simple Optional The HS6Digit for the individual item.
lineItemReference simple Optional The line item reference for the individual item.
countryOfOrigin simple Optional The country where the item originated from (not where it was manufactured).
countryOfManafacture simple Optional The country where the item was manufactured.
composition simple Optional The details of the materials used for the composition of this item.
goodsValue simple Optional The value of the goods being send.
goodsCurrency simple Optional The currency type of the goods value.

Used in getManifest.

Back

AvailableQuote

Sample AvailableQuote XML

<quote id="200001" type=”com:AvailableQuote”>
    <generated>Automatically</generated>
    <accepted>Y</accepted>
    <bookingNumber>ZYX300001</bookingNumber>
    <consignmentNumber>UVW400001</consignmentNumber>
    <consignmentDocument>JVBER … shortened for readability … XRhbG </consignmentDocument>
    <consignmentDocumentType>application/pdf</consignmentDocumentType>
    <labelDocument>e3Rf3 … shortened for readability … X8ggy </labelDocument>
    <labelDocumentType>application/pdf</labelDocumentType>
    <manifestNumber>DEF000001</manifestNumber>
    <articles>
        <article>
            <anythingIndex>1</anythingIndex>
            <articleNumber>GHI000001</articleNumber>
            <labelDocument>4dr22 … shortened for readability … f3d9j </labelDocument>
            <labelDocumentType>application/pdf</labelDocumentType>
        </article>
        <article>
            <anythingIndex>2</anythingIndex>
            <articleNumber>GHI000002</articleNumber>
            <labelDocument>jdk8s … shortened for readability … 9dks0 </labelDocument>
            <labelDocumentType>application/pdf</labelDocumentType>
        </article>
    </articles>
    <trackingStatus>In Transit</trackingStatus>
    <trackingStatusOccurred>2009-07-02T15:25:46Z </trackingStatusOccurred>
    <trackingLastChecked>2009-07-02T18:13:12Z</trackingLastChecked>
    <trackingFurtherDetails/>
    <totalPrice>11.00</totalPrice>
    <basePrice>10.00</basePrice>
    <tax>1.00</tax>
    <currency>AUD</currency>
    <deliveryMethod>Off-peak</deliveryMethod>
    <usingGeneralRail>N</usingGeneralRail>
    <usingGeneralRoad>Y</usingGeneralRoad>
    <usingGeneralSea>N</usingGeneralSea>
    <usingExpressAir>N</usingExpressAir>
    <usingExpressRoad>N</usingExpressRoad>
    <etaFrom>1</etaFrom>
    <etaTo>2</etaTo>
    <guaranteedEta>Y</guaranteedEta>
    <adjustments>
        <adjustment>
            <description>Credit Card Payment Adjustment</description>
            <amount>0.20</amount>
            <tax>0.02</tax>
        </adjustment>
        <adjustment>
            <description>Credit Payment Adjustment</description>
            <amount>-0.20</amount>
            <tax>-0.02</tax>
        </adjustment>
    </adjustments>
    <inclusions>
        <inclusion>
            <summary>Tracking available</summary>
            <details>Tracking information will be available for this quote.</details>
        </inclusion>
        <inclusion>
            <summary>Automatic Booking</summary>
            <details>Automatic booking generated.</details>
        </inclusion>
        <inclusion>
            <summary>Automatic Consignment</summary>
            <details>Automatic consignment note generated.</details>
        </inclusion>
    </inclusions>
    <extras>
        <extra>
            <summary>Insurance</summary>
            <details>Insurance cover up to $5,000.</details>
            <totalPrice>2.20</totalPrice>
            <basePrice>2.00</basePrice>
            <tax>0.20</tax>
            <mandatory>Y</mandatory>
            <adjustments>
                <adjustment>
                    <description>Credit Card Payment Adjustment</description>
                    <amount>0.04</amount>
                    <tax>0.00</tax>
                </adjustment>
            </adjustments>
        </extra>
    </extras>
    <carrier>
        <id>654321</id>
        <companyName>ZYX Transport</companyName>
        <companyContact>John Doe</companyContact>
        <streetAddress>1 Transport Street</streetAddress>
        <streetSuburb>Brisbane</streetSuburb>
        <streetCity>Brisbane</streetCity>
        <streetState>QLD</streetState>
        <streetCode>4000</streetCode>
        <streetCountry>AU</streetCountry>
        <postalAddress>PO Box 1111</postalAddress>
        <postalSuburb>Brisbane</postalSuburb>
        <postalCity>Brisbane</postalCity>
        <postalState>QLD</postalState>
        <postalCode>4001</postalCode>
        <postalCountry>AU</postalCountry>
        <phone1>(07) 3333 3333</phone1>
        <email>john.doe@zyxtransport.com.au</email>
        <website>https://www.zyxtransport.com.au</website>
        <conditions>Our conditions include: lots of text.</conditions>
    </carrier>
</quote>

The specific details about an available quote (a quote that has been accepted).

Field Type Occurs Description
id (attribute) list Optional Attribute: Unique identifier for the quote.
generated simple Required How the quote was generated.
accepted simple Required Whether the quote has been accepted by the client.
bookingNumber simple Optional The carrier booking number representing that the quote has been confirmed by the carrier.
consignmentNumber simple Optional The carrier’s consignment number identifies a logical grouping of goods that has been consigned.
consignmentDocument simple Optional The carrier’s consignment document. Important: The contents of this field are encoded using base64. This is done to ensure that the binary data that forms the file’s contents survive transport through the transport layer. When creating a file from this field’s contents you will need to ensure that you decode using base64.
consignmentDocumentType simple Optional The type of the carrier’s consignment document. This is only provided if an entry for the consignmentDocument field is provided.
labelDocument simple Optional The carrier’s label document. Important: The contents of this field are encoded using base64. This is done to ensure that the binary data that forms the file’s contents survive transport through the transport layer. When creating a file from this field’s contents you will need to ensure that you decode using base64.
labelDocumentType simple Optional The type of the carrier’s label document. This is only provided if an entry for the labelDocument field is provided.
manifestNumber simple Optional The carrier’s manifest number identifies a logical grouping of consignments. This is optional as the carrier may not require this or a number has not yet been assigned (ie. request has not been confirmed for manifesting).
articles simple Optional The details about the individual items being sent.
trackingStatus simple Optional The status of the transit of the items being sent.
trackingStatusOccured simple Optional When the tracking status event occurred.
trackingStatusChecked simple Optional When the tracking status was last checked on.
trackingFurtherDetails simple Optional Further details on the transit of the items being sent.
trackingHistories list Optional The list of tracking history records.
totalPrice simple Required The total price of the quote, including tax.
basePrice simple Required The base price of the quote, before tax is added.
tax simple Required The total tax amount for the quote.
currency simple Required The currency used for all monetary amounts quoted.
deliveryMethod simple Required The delivery method that the quote price is based on.
usingGeneralRail simple Required Whether the delivery method utilises General – Rail as a method of transportation.
usingGeneralRoad simple Required Whether the delivery method utilises General – Road as a method of transportation.
usingGeneralSea simple Required Whether the delivery method utilises General – Sea as a method of transportation.
usingExpressAir simple Required Whether the delivery method utilises Express - Air as a method of transportation.
usingExpressRoad simple Required Whether the delivery method utilises Express - Road as a method of transportation.
etaFrom simple Required The minimum ETA (estimated time of arrival).
etaTo simple Required The maximum ETA (estimated time of arrival).
guaranteedEta simple Required Whether the ETA values supplied are guaranteed by the Carrier.
adjustments list Required Any adjustments to the prices which are applied at the booking stage (eg. credit card fee).
inclusions list Required Any inclusions that are included in the price (eg. tracking).
extras list Required Any extras that are available for a quote (eg. insurance).
carrier complex Required The carrier that has provided the quote.
originatingDepot complex Optional Details of the depot that the item is being sent from. Only applies if itemMethod is Depot to Depot.
destinationDepot complex Optional Details of the depot that the item is being sent from. Only applies if itemMethod is Depot to Depot.

Back

BookingQuote

Sample BookingQuote XML

<quote xsi:type=“com:BookingQuote”>
    <totalPrice>11.00</totalPrice>
    <basePrice>10.00</basePrice>
    <tax>1.00</tax>
    <currency>AUD</currency>
    <deliveryMethod>Off-peak</deliveryMethod>
    <etaFrom>2</etaFrom>
    <etaTo>3</etaTo>
    <guaranteedEta>Y</guaranteedEta>
    <carrierId>654321</carrierId>
    <extras>
        <extra>
            <summary>Insurance</summary>
            <totalPrice>2.20</totalPrice>
            <basePrice>2.00</basePrice>
            <tax>0.20</tax>
        </extra>
    </extras>
</quote>

Specific details about a quote to be accepted (a quote that has not yet been accepted).

Field Type Occurs Description
totalPrice simple Required The total price of the quote, including tax.
basePrice simple Required The base price of the quote, before tax is added.
tax simple Required The total tax amount for the quote.
currency simple Required The currency used for all monetary amounts quoted.
deliveryMethod simple Required The delivery method that the quote price is based on.
etaFrom simple Required The minimum ETA (estimated time of arrival).
etaTo simple Required The maximum ETA (estimated time of arrival).
guaranteedEta simple Required Whether the ETA values supplied are guaranteed by the carrier.
carrierId simple Required The unique identifier of a carrier providing the quote.
extras simple Optional Any extras to be included for the quote (eg. insurance).

Used in makeBooking.

Back

Carrier

Sample Carrier XML

<carrier xsi:type=“com:Carrier”>
    <id>654321</id>
    <companyName>ZYX Transport</companyName>
    <companyContact>John Doe</companyContact>
    <streetAddress>1 Transport Street</streetAddress>
    <streetSuburb>Brisbane</streetSuburb>
    <streetCity>Brisbane</streetCity>
    <streetState>QLD</streetState>
    <streetCode>4000</streetCode>
    <streetCountry>AU</streetCountry>
    <postalAddress>PO Box 1111</postalAddress>
    <postalSuburb>Brisbane</postalSuburb>
    <postalCity>Brisbane</postalCity>
    <postalState>QLD</postalState>
    <postalCode>4001</postalCode>
    <postalCountry>AU</postalCountry>
    <phone1>(07) 3333 3333</phone1>
    <email>john.doe@zyxtransport.com.au</email>
    <website>https://www.zyxtransport.com.au</website>
    <conditions>Our conditions include: lots of text.</conditions>
</carrier>

Specific details about a carrier.

Field Type Occurs Description
carrierId simple Required The unique identifier for a carrier.
companyName simple Required The name of a carrier.
companyContact simple Required The person’s name or position description of the contact for the carrier.
streetAddress simple Optional The street details for the street address of the carrier.
streetSuburb simple Optional The suburb for the street address of the carrier.
streetCity simple Optional The city for the street address of the carrier.
streetState simple Optional The state for the street address of the carrier.
streetCode simple Optional The postal code for the street address of the carrier.
streetCountry simple Optional The country for the street address of the carrier.
postalAddress simple Optional The street details for the postal address of the carrier.
postalSuburb simple Optional The suburb for the postal address of the carrier.
postalCity simple Optional The city for the postal address of the carrier.
postalState simple Optional The state for the postal address of the carrier.
postalCode simple Optional The postal code for the postal address of the carrier.
postalCountry simple Optional The country for the postal address of the carrier.
phone1 simple Optional The first phone number for the carrier.
phone2 simple Optional The second phone number for the carrier.
email simple Optional The contact email address for the carrier.
website simple Optional The carrier’s website.
conditions simple Optional The carrier specific conditions for transporting an items.

Used in AvailableQuote.

Back

CarrierPreference

Sample CarrierPreference XML

<carrierPreference xsi:type=”com:CarrierPreference”>
    <carrierId>654321</carrierId>
    <deliveryMethods>
        <deliveryMethod>Off-peak</deliveryMethod>
    </deliveryMethods>
</carrierPreference>

The dispatch details of the consignment.

Field Type Occurs Description
carrierId simple Required The carrier id for the required carrier.
deliveryMethods list Optional Any delivery methods to restrict the quotes.

Note: Some CarrierPreferences are only valid with some QuotePreferences.

Used in getQuotes and makeBooking.

Back

Client

Sample Client XML

<client xsi:type=“com:Client”>
    <id>123456</id>
    <individualCompany>Individual</individualCompany>
    <individualSurname>Smith</individualSurname>
    <individualFirstname>John</individualFirstname>
    <individualDateOfBirth>1980-04-21</individualDateOfBirth>
    <streetAddress>1 User Street</streetAddress>
    <streetSuburb>Melbourne</streetSuburb>
    <streetCity>Melbourne</streetCity>
    <streetState>VIC</streetState>
    <streetCode>3000</streetCode>
    <streetCountry>AU</streetCountry>
    <postalAddress>PO Box 3333</postalAddress>
    <postalSuburb>Melbourne</postalSuburb>
    <postalCity>Melbourne</postalCity>
    <postalState>VIC</postalState>
    <postalCode>3001</postalCode>
    <postalCountry>AU</postalCountry>
    <phone1>(03) 9999 9999</phone1>
    <email>john.smith@mailhost.com.au</email>
</client>

Specific details about a client.

Field Type Occurs Description
id simple Optional* The unique identifier for a client.
individualCompany simple Required Whether the account is for an individual or a company.
companyName simple Optional* The company name of a client.
companyContactPerson simple Optional* The person’s name or position description of the contact for the client.
companyNo simple Optional* The allocated company number for a client.
individualSurname simple Optional* The individual client’s surname.
individualFirstname simple Optional* The individual client’s firstname.
individualDateOfBirth simple Optional* The individual client’s date of birth.
streetAddress simple Optional The street details for the street address of the client.
streetSuburb simple Optional The suburb for the street address of the client.
streetCity simple Optional The city for the street address of the client.
streetState simple Optional The state for the street address of the client.
streetCode simple Optional The postal code for the street address of the client.
streetCountry simple Required The country for the street address of the client.
postalAddress simple Optional The street details for the postal address of the client.
postalSuburb simple Optional The suburb for the postal address of the client.
postalCity simple Optional The city for the postal address of the client.
postalState simple Optional The state for the postal address of the client.
postalCode simple Optional The postal code for the postal address of the client.
postalCountry simple Optional The country for the postal address of the client.
phone1 simple Optional The first phone number for the client.
phone2 simple Optional The second phone number for the client.
email simple Required The contact email address for the client.

Further Restrictions:

Further to the restrictions applied by the field’s base type and element conditions (eg. minOccurs=“0”), the following rules will also be applied after the data has passed the XML tests:

Field Further restrictions
id Applies (and is mandatory) only if:
  • the client already exists.
companyName Applies (and is mandatory) only if:
  • individualCompany is Company.
companyContactPerson Applies (and is mandatory) only if:
  • individualCompany is Company.
companyNo Applies (and is mandatory) only if:
  • individualCompany is Company.
individualSurname Applies (and is mandatory) only if:
  • individualCompany is Individual.
individualFirstname Applies (and is mandatory) only if:
  • individualCompany is Individual.
individualDateOfBirth Applies (and is mandatory) only if:
  • individualCompany is Individual.

Used in createClient, updateClient and getClient.

Back

Depot

Sample Depot XML

<depot xsi:type=“com:Depot”>
    <name>BNE Depot</name>
    <street>1 Transport Street</streetAddress>
    <suburb>Brisbane</streetSuburb>
    <city>Brisbane</streetCity>
    <state>QLD</streetState>
    <code>4000</streetCode>
    <country>AU</streetCountry>
    <phone1>(07) 3333 3333</phone1>
    <fax>(07) 3333 3331</fax>
    <instructions>Come to the Red door.</instructions>
</depot>

Specific details about a carrier’s depot.

Field Type Occurs Description
name simple Required The name of the depot, as defined by the carrier.
street simple Optional The street details for the street address of the carrier.
suburb simple Optional The suburb for the street address of the carrier.
city simple Optional The city for the street address of the carrier.
state simple Optional The state for the street address of the carrier.
code simple Optional The postal code for the street address of the carrier.
country simple Optional The country for the street address of the carrier.
phone1 simple Optional The first phone number for the carrier.
phone2 simple Optional The second phone number for the carrier.
fax simple Optional The fax number for the carrier.
instructions simple Optional Any specific instructions relating to the drop-off or pickup of items to/from this depot.

Used in AvailableQuote.

Back

DispatchDetails

Sample DispatchDetails XML

<dispatchDetails xsi:type=”com:DispatchDetails”>
    <consignmentNumber>UVW40002</consignmentNumber>
    <consignmentDate>2009-07-02</consignmentDate>
    <distanceMeasurementType>Centimetres</distanceMeasurementType>
    <weightMeasurementType>Kilograms</weightMeasurementType>
    <actualWeight>10</actualWeight>
    <chargeableWeight>8</chargeableWeight>
    <length>50</length>
    <width>50</width>
    <height>50</height>
    <currency>AUD</currency>
    <basePrice>10.00</basePrice>
    <tax>1.00</tax>
    <totalPrice>11.00</totalPrice>
    <description>bicycle parts.</description>
</dispatchDetails>

The dispatch details of the consignment.

Field Type Occurs Description
reference simple Optional The reference code used by a carrier company to refer to a particular request.
carrierName simple Optional The name of the carrier sending the items.
carrierId simple Optional The unique id for a carrier.
accountNo simple Optional The reference code used by a carrier company to refer to the Temando account.
creatorId simple Optional The reference code used by a carrier company to refer to the third party (ie. not Temando) that created a request.
currency simple Optional The currency used for all monetary amounts.
changedCarrier simple Optional Whether the originally accepted quote has been changed to another carrier.
consignmentNumber simple Optional The carrier’s consignment number identifies a logical grouping of goods that has been consigned.
consignmentDate simple Optional When the consignment was generated.
deliveryMethod simple Optional The delivery method to be used for the request.
rateName simple Optional The rate classification for the item/s that was used for rate calculation.
description simple Optional Further details of the item being sent, that have not been specified in other elements.
distanceMeasurementType simple Optional The distance measurement type to be used for the Length, Width and Height values.
weightMeasurementType simple Optional The weight measurement type to be used for the Weight values.
length simple Optional The length of the item being sent.
width simple Optional The width of the item being sent.
height simple Optional The height of the item being sent.
actualWeight simple Optional The actual weight of the item being sent.
chargeableWeight simple Optional The chargeable weight of the item being sent.
actualCubic simple Optional The actual cubic of the item being sent.
chargeableCubic simple Optional The chargeable cubic of the item being sent.
actualQuantity simple Optional The actual number of items being sent.
chargeableQuantity simple Optional The chargeable number of items being sent.
basePrice simple Optional The base price of the quote, excluding surcharges and tax.
surcharges simple Optional Any surcharges to be included in the total price.
tax simple Optional The tax amount.
totalPrice simple Optional The total price of the quote, including base price, surcharges and tax.
originZoneName simple Optional A name of the carrier zone that the sender’s address is matched to.
originContactName simple Optional A contact name for an individual at the origin location.
originCompanyName simple Optional The company name (if relevant) for the sender.
originStreet simple Optional The street details for the address.
originSuburb simple Optional The suburb for the address.
originState simple Optional The state for the address.
originCode simple Optional The postal code for the address.
originCountry simple Optional The country for the address.
originPhone1 simple Optional The first phone number for the address.
originPhone2 simple Optional The second phone number for the address.
originFax simple Optional The fax number for the address.
originEmail simple Optional The email address for the address.
destinationZoneName simple Optional A name of the carrier zone that the receiver’s address is matched to.
destinationContactName simple Optional A contact name for an individual at the destination location.
destinationCompanyName simple Optional The company name (if relevant) for the receiver.
destinationStreet simple Optional The street details for the address.
destinationSuburb simple Optional The suburb for the address.
destinationState simple Optional The state for the address.
destinationCode simple Optional The postal code for the address.
destinationCountry simple Optional The country for the address.
destinationPhone1 simple Optional The first phone number for the address.
destinationPhone2 simple Optional The second phone number for the address.
destinationFax simple Optional The fax number for the address.
destiantionEmail simple Optional The email address for the address.

Used in getManifest.

Back

Extra

Sample Extra XML

<extra xsi:type=“com:Extra”>
    <summary>Insurance</summary>
    <details>Insurance cover up to $5,000.</details>
    <totalPrice>2.20</totalPrice>
    <basePrice>2.00</basePrice>
    <tax>0.20</tax>
    <mandatory>Y</mandatory>
    <adjustments>
        <adjustment>
            <description>Credit Card Payment Adjustment</description>
            <amount>0.04</amount>
            <tax>0.00</tax>
        </adjustment>
    </adjustments>
</extra>

Specific details about an extra available for a quote.

Field Type Occurs Description
summary simple Required The summary of the extra details. This is a unique identifier for the extra.
details simple Optional The full details of the extra.
totalPrice simple Optional The total price of the extra, including tax.
basePrice simple Optional The base price of the extra, before tax is added.
tax simple Optional The total tax amount for the extra.
mandatory simple Optional Whether the extra is mandatory or not.
adjustments simple Optional Any adjustments to the prices which are applied at the booking stage (eg. credit card fee).

Used in AvailableQuote and BookingQuote.

Back

General

Sample General XML

<general xsi:type=“com:General”>
    <goodsValue>2000.00</goodsValue>
</general>

The general details about the items being sent.

Field Type Occurs Description
goodsValue simple Optional The value of the goods being sent.
goodsCurrency simple Optional The currency of the value of the goods being sent.
externalInsuranceValue simple Optional The insured value of the goods being sent. Only required if international delivery and the item has been insured externally to Temando.
externalInsuranceCurrency simple Optional The currency of the insured value of the goods being sent.
termsOfTrade simple Optional Whether the delivery duty has been paid or not. Only required if an international delivery.

Used in getQuotes and makeBooking.

Back

Inclusion

Sample Inclusion XML

<inclusion xsi:type=“com:Inclusion”>
    <summary>Tracking available</summary>
    <details>Tracking information will be available for this quote. </details>
</inclusion>

Specific details about an inclusion for a quote.

Field Type Occurs Description
summary simple Required The summary of the inclusion details. This is a unique identifier for the inclusion.
details simple Optional The full details of the inclusion.

Used in AvailableQuote.

Back

Location

Sample Location XML

<location xsi:type=“com:Location”>
    <contactName>John Doe</contactName>
    <type>Origin</type>
    <companyName>ABC Suppliers</companyName>
    <street>1 Originating Street</street>
    <suburb>Brisbane</suburb>
    <state>QLD</state>
    <code>4000</code>
    <country>AU</country>
    <phone1>(07) 3333 3333</phone1>
    <phone2/>
    <fax>(07) 3333 3331</fax>
    <email>bneoffice@abcsuppliers.com.au</email>
    <postalBox>N</postalBox>
    <dock>N</dock>
    <forklift>N</forklift>
    <loadingFacilities>N</loadingFacilities>
</location>

The details about where an items are being sent from (or the originating address).

Field Type Occurs Description
description simple Optional A description allocated to a predefined location stored in the client’s location listings.
type simple Optional Whether the location is a originating address (ie. pickup) or a destination address (dropoff).
contactName simple Optional* A contact name for the location.
companyName simple Optional* A descriptive name for the location.
street simple Optional* The street details for the address.
suburb simple Optional* The suburb for the address.
state simple Optional* The state for the address.
code simple Optional* The postal code for the address.
country simple Optional* The country for the address.
phone1 simple Optional* The first phone number for the address.
phone2 simple Optional The second phone number for the address.
fax simple Optional The fax number for the address.
email simple Optional* The email address for the address.
postalBox simple Optional* Is the address a postal box?
dock simple Optional* Does the address have a dock?
forklift simple Optional* Does the address have a forklift?
loadingFacilities simple Optional* Does the address have loading facilities?

Further Restrictions:

Further to the restrictions applied by the field’s base type and element conditions (eg. minOccurs=“0”), the following rules will also be applied after the data has passed the XML tests:

Field Further restrictions
type Applies (and is mandatory) only if:
  • description has not been supplied.
contactName Applies (and is mandatory) only if:
  • description has not been supplied.
companyName Applies (and is mandatory) only if:
  • description has not been supplied and originIs/destinationIs is Business.
street Applies (and is mandatory) only if:
  • description has not been supplied.
suburb Applies (and is mandatory) only if:
  • description has not been supplied.
state Applies (and is mandatory) only if:
  • description has not been supplied.
code Applies (and is mandatory) only if:
  • description has not been supplied.
country Applies (and is mandatory) only if:
  • description has not been supplied.
phone1 Applies (and is mandatory) only if:
  • description has not been supplied.
email Applies (and is mandatory) only if:
  • description has not been supplied.
postalBox Applies (and is mandatory) only if:
  • description has not been supplied.
dock Applies (and is mandatory) only if:
  • description has not been supplied.
forklift Applies (and is mandatory) only if:
  • description has not been supplied.
loadingFacilities Applies (and is mandatory) only if:
  • description has not been supplied.

Used in GetQuotes, makeBooking and Request.

Back

LoginDetails

Sample LoginDetails XML

<loginDetails xsi:type=“com:LoginDetails”>
    <loginId>jsmith</loginId>
    <password>my_password1357</password>
</loginDetails>

The login details for an account.

Field Type Occurs Description
loginId simple Optional Login id for an account.
password simple Required Password for an account.

Used in createClient and getClient.

Back

Manifest

Sample Manifest XML

<manifest xsi:type=”com:Manifest”>
    <manifestNumber>DEF000001</manifestNumber>
    <carrierId>654321</carrierId>
    <originDescription>ABC Suppliers</originDescription>
</manifest>

The manifest details of the consignment.

Field Type Occurs Description
manifestNumber simple Optional The manifest number for the carrier manifest.
carrierId simple Required The carrier id for the corresponding manifest number.
originDescription simple Optional The location description for the origin being manifested.

Used in confirmManifest.

Back

Payment

Sample Payment XML

<payment xsi:type=“com:Payment”>
    <paymentType>Account</paymentType>
</payment>

The details about a payment. Includes information about the payment type and any specific details related to the payment type specified.

Field Type Occurs Description
paymentType Simple Required The payment method to be used for paying an amount.
cardType Simple Optional* The type of credit card being supplied.
cardExpiryDate Simple Optional* The expiry date of the credit card being supplied.
cardNumber Simple Optional* The number of the credit card being supplied.
cardName Simple Optional* The name of the owner of the credit card being supplied.

Further Restrictions:

Further to the restrictions applied by the field’s base type and element conditions (eg. minOccurs=“0”), the following rules will also be applied after the data has passed the XML tests:

Field Further restrictions
cardType Applies (and is mandatory) only if:
  • paymentType is Credit Card.
cardExpiryDate Applies (and is mandatory) only if:
  • paymentType is Credit Card
Must be a date after the current date.
cardNumber Applies (and is mandatory) only if:
  • paymentType is Credit Card
Validated based on rules specific to cardTypes and using the Luhn algorithm (mod 10).
cardName Applies (and is mandatory) only if:
  • paymentType is Credit Card

Used in makeBooking.

Back

QuoteFilter

Sample QuoteFilter XML

<quoteFilter xsi:type=”com:QuoteFilter”>
    <preference>Carriers Only</preference>
    <carriers>
        <carrier>
            <carrierId>654321</carrierId>
            <deliveryMethods>
                <deliveryMethod>Off-peak</deliveryMethod>
            </deliveryMethods>
        </carrier>
    </carriers>
    <extras>
        <summary>Insurance</summary>
    </extras>
</quoteFilter>

The dispatch details of the consignment.

Field Type Occurs Description
preference simple Required The type of quote filter to be applied.
carriers list Optional A list of CarrierPreferences used to filter potential quotes. If:
  • Specified, preference field should be set to Carriers Only or Carriers Order.
  • Not Specified, preference field should be set to Cheapest.
extras list Optional Any extras to be included in the potential quotes.

Used in getQuotes and makeBooking.

Request

Sample Request XML

<request id="100000" type=”com:Request”>
    <status>Completed</status>
    <anythings>
        <anything>
            <class>Freight</class>
            <mode>Less than load</mode>
            <packaging>Carton</packaging>
            <qualifierFreightGeneralFragile>N</qualifierFreightGeneralFragile>
            <distanceMeasurementType>Centimetres</distanceMeasurementType>
            <weightMeasurementType>Kilograms</weightMeasurementType>
            <length>10</length>
            <width>10</width>
            <height>10</height>
            <weight>1</weight>
            <quantity>2</quantity>
            <description>Contains hats.</description>
        </anything>
    </anythings>
    <anywhere>
        <itemNature>Domestic</itemNature>
        <itemMethod>Door to Door</itemMethod>
        <originCountry>AU</originCountry>
        <originCode>4000</originCode>
        <originSuburb>Brisbane</originSuburb>
        <destinationCountry>AU</destinationCountry>
        <destinationCode>2000</destinationCode>
        <destinationSuburb>Sydney</destinationSuburb>
        <destinationIs>Residence</destinationIs>
        <destinationResPostalBox>N</destinationResPostalBox>
        <destinationResUnattended>N</destinationResUnattended>
        <destinationResInside>N</destinationResInside>
        <destinationResLimitedAccess>N</destinationResLimitedAccess>
        <destinationResHeavyLift>N</destinationResHeavyLift>
        <originIs>Business</originIs>
        <originBusUnattended>N</originBusUnattended>
        <originBusDock>Y</originBusDock>
        <originBusForklift>N</originBusForklift>
        <originBusLoadingFacilities>N</originBusLoadingFacilities>
        <originBusInside>N</originBusInside>
        <originBusLimitedAccess>N</originBusLimitedAccess>
        <originBusHeavyLift>N</originBusHeavyLift>
        <originBusTailgateLifter>N</originBusTailgateLifter>
        <originBusContainerSwingLifter>N</originBusContainerSwingLifter>
    </anywhere>
    <anytime>
        <readyDate>2009-07-01</readyDate>
        <readyTime>PM</readyTime>
    </anytime>
    <general>
        <goodsValue>50.00</goodsValue>
    </general>
    <origin>
        <description>ABC Suppliers</description>
    </origin>
    <destination>
        <contactName>Jane Doe</contactName>
        <street>2 Recipient Street</street>
        <suburb>Sydney</suburb>
        <state>NSW</state>
        <code>2000</code>
        <country>AU</country>
        <phone1>(02) 9333 3333</phone1>
        <phone2/>
        <fax>(02) 9333 3331</fax>
        <email>jane.doe@yahoo.com.au</email>
    </destination>
    <origin>
        <description>ABC Suppliers – PO Box</description>
    </origin>
    <quotes>
        <quote id=”111111”>
            <generated>Automatically</generated>
            <accepted>Y</accepted>
            <bookingNumber>XYZ300001</bookingNumber>
            <consignmentNumber>UVW400001</consignmentNumber>
            <consignmentDocument>JVBER … shortened for readability … XRhbG </consignmentDocument>
            <consignmentDocumentType>application/pdf</consignmentDocumentType>
            <labelDocument>e3Rf3 … shortened for readability … X8ggy </labelDocument>
            <labelDocumentType>application/pdf</labelDocumentType>
            <trackingStatus>In Transit</trackingStatus>
            <trackingStatusOccurred>2009-07-02T15:25:46Z </trackingStatusOccurred>
            <trackingLastChecked>2009-07-02T18:13:12Z </trackingLastChecked>
            <trackingFurtherDetails/>
            <totalPrice>11.00</totalPrice>
            <basePrice>10.00</basePrice>
            <tax>1.00</tax>
            <currency>AUD</currency>
            <deliveryMethod>Off-peak</deliveryMethod>
            <usingGeneralRail>N</usingGeneralRail>
            <usingGeneralRoad>Y</usingGeneralRoad>
            <usingGeneralSea>N</usingGeneralSea>
            <usingExpressAir>N</usingExpressAir>
            <usingExpressRoad>N</usingExpressRoad>
            <etaFrom>2</etaFrom>
            <etaTo>3</etaTo>
            <guaranteedEta>Y</guaranteedEta>
            <carrierId>654321</carrierId>
            <extras>
                <extra>
                    <summary>Insurance</summary>
                    <totalPrice>2.20</totalPrice>
                    <basePrice>2.00</basePrice>
                    <tax>0.20</tax>
                </extra>
            </extras>
        </quote>
    </quotes>
    <instructions>Please use side door.</instructions>
    <reference>ABC200000</reference>
    <comments>Please don't use any chains on the axle.</comments>
</request>

The specific details about the items being sent.

Field Type Occurs Description
id (attribute) positiveInteger Optional Attribute: Unique identifier for the request.
status simple Required The status of the request.
anythings list Required The list of anything details of the items being sent.
anywhere complex Optional The anywhere details of the items being sent.
anytime complex Optional The anytime details of the items being sent.
general complex Optional The general details of the items being sent.
origin complex Optional The origin details of the items being sent.
destination complex Optional The destination details of the items being sent.
returnto complex Optional The return to details of the items being sent. This value should be supplied if the location differs to the origin.
quotes list Required The list of quotes for the items being sent.
instructions simple Optional The delivery instructions relating to the items being sent.
reference simple Optional The user supplied reference relating to the request.
comments simple Optional The user supplied comments relating to the items being sent.

Used in getRequest and getManifest.

Back

trackingHistory

Sample trackingHistory XML

<trackingHistory>
    <trackingStatus>awaiting pickup</trackingStatus>
    <trackingStatusOccurred>2016-10-03T14:51:12Z</trackingStatusOccurred>
    <trackingLastChecked>2016-10-03T03:51:12Z</trackingLastChecked>
    <trackingFurtherDetails></trackingFurtherDetails>
</trackingHistory>

Tracking history of the consignment.

Field Type Occurs Description
trackingStatus trackingStatus Required Tracking status
trackingStatusOccurred DateTime Required Date and time when tracking status was first obtained.
trackingLastChecked DateTime Required Date and time when tracking was last checked.
trackingFurtherDetails string Optional Further details about the tracking.

Simple Data Types

Address

Address XML Structure

<xsd:simpleType name="Address">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="100"/>
    </xsd:restriction>
</xsd:simpleType>

The street or postal address of a location.

Possible values:

  • Any string up to 100 characters long

Back

AdjustmentDescription

AdjustmentDescription XML Structure

<xsd:simpleType name="AdjustmentDescription">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The description of an adjustment that can be or is applied to a quote amount.

Possible Values:

  • Any string up to 50 characters long

Back

AnimalAge

AnimalAge XML Structure

<xsd:simpleType name="AnimalAge">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1"/>
        <xsd:maxInclusive value="100"/>
    </xsd:restriction>
</xsd:simpleType>

The age of the animal being sent.

Possible values:

  • Any int between 1 and 100

Back

AnimalBreed

AnimalBreed XML Structure

<xsd:simpleType name="AnimalBreed">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The breed of the animal being sent.

Possible values:

  • Any string up to 50 characters long

Back

AnimalCrate

AnimalCrate XML Structure

<xsd:simpleType name="AnimalCrate">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Hire 1"/>
        <xsd:enumeration value="Hire 2"/>
        <xsd:enumeration value="Buy 1"/>
        <xsd:enumeration value="Buy 2"/>
        <xsd:enumeration value="I have a crate"/>
    </xsd:restriction>
</xsd:simpleType>

The type of crate to be used to transport the animal being sent.

Possible values:

  • Hire 1
  • Hire 2
  • Buy 1
  • Buy 2
  • I have a crate

Back

AnimalType

AnimalType XML Structure

<xsd:simpleType name="AnimalType">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The type of the livestock being sent.

Possible values:

  • Any string up to 50 characters long

Back

ArticleId

ArticleId XML Structure

<xsd:simpleType name="ArticleId">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1"/>
        <xsd:maxInclusive value="999999999"/>
    </xsd:restriction>
</xsd:simpleType>

The Id of an article.

Possible Values:

  • Any int between 1 and 999999999

AnythingIndex

AnythingIndex XML Structure

<xsd:simpleType name="AnythingIndex">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1"/>
        <xsd:maxInclusive value="999999999"/>
    </xsd:restriction>
</xsd:simpleType>

The anything index for a request.

Possible Values:

  • Any int between 1 and 999999999

ArticleNumber

ArticleNumber XML Structure

<xsd:simpleType name="ArticleNumber">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The article number associated with an individual item.

Possible Values:

  • Any string up to 50 characters long

ASIN

ASIN XML Structure

<xsd:simpleType name="ASIN">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="10"/>
    </xsd:restriction>
</xsd:simpleType>

The Amazon Standard Identification Number (ASIN) is a unique identification number assigned by Amazon.com and its partners for product identification within the Amazon.com organization.

Possible Values:

  • Any string up to 10 characters long

BoatMake

BoatMake XML Structure

<xsd:simpleType name="BoatMake">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The make of the boat being sent.

Possible values:

  • Any string up to 50 characters long

BoatModel

BoatModel XML Structure

<xsd:simpleType name="BoatHullType">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The hull type of the boat being sent.

Possible values:

  • Any string up to 50 characters long

BookingNumber

BookingNumber XML Structure

<xsd:simpleType name="BookingNumber">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The booking number allocated by the carrier (associated with a quote) representing that the request has been confirmed and booked.

Possible Values:

  • Any string up to 50 characters long

CarrierAccountNumber

CarrierAccountNumber XML Structure

<xsd:simpleType name="CarrierAccountNumber">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="20"/>
    </xsd:restriction>
</xsd:simpleType>

The reference code used by a carrier company to refer to the Temando account.

Possible Values:

  • Any string up to 20 characters long

CarrierConditions

CarrierConditions XML Structure

<xsd:simpleType name="CarrierConditions">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="20000"/>
    </xsd:restriction>
</xsd:simpleType>

The terms and conditions for sending an item via a carrier, as defined by that carrier (ie. not Temando’s conditions but the carrier’s conditions).

Possible Values:

  • Any string up to 20000 characters long

CarrierCreatorId

CarrierCreatorId XML Structure

<xsd:simpleType name="CarrierCreatorId">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="40"/>
    </xsd:restriction>
</xsd:simpleType>

The reference code used by a carrier company to refer to a third party (ie. not Temando) that created a request.

Possible Values:

  • Any string up to 40 characters long

CarrierId

CarrierId XML Structure

<xsd:simpleType name="CarrierId">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1"/>
        <xsd:maxInclusive value="999999999"/>
    </xsd:restriction>
</xsd:simpleType>

The unique id for a carrier.

Possible Values:

  • Any integer between 1 and 999999999

CarrierReference

CarrierReference XML Structure

<xsd:simpleType name="CarrierReference">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="100"/>
    </xsd:restriction>
</xsd:simpleType>

The reference code used by a carrier company to refer to a particular request.

Possible Values:

  • Any string up to 100 characters long

City

City XML Structure

<xsd:simpleType name="City">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

A city or town within a State or Country.

Possible Values:

  • Any string up to 50 characters long

Class

Class XML Structure

<xsd:simpleType name="Class">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Freight"/>
        <xsd:enumeration value="General Goods"/>
        <xsd:enumeration value="Vehicle"/>
        <xsd:enumeration value="Boat"/>
        <xsd:enumeration value="Animal"/>
        <xsd:enumeration value="Refrigerated"/>
        <xsd:enumeration value="Other"/>
    </xsd:restriction>
</xsd:simpleType>

The class of the item being sent.

Possible values:

  • Freight
  • General Goods
  • Vehicle
  • Boat
  • Animal
  • Refrigerated
  • Other

ClientId

ClientId XML Structure

<xsd:simpleType name="ClientId">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1"/>
        <xsd:maxInclusive value="999999999"/>
    </xsd:restriction>
</xsd:simpleType>

The unique id for a client.

Possible Values:

  • Any int between 1 and 999999999

ClientReference

ClientReference XML Structure

<xsd:simpleType name="ClientReference">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="100"/>
    </xsd:restriction>
</xsd:simpleType>

The reference code used by a client to refer to a particular request.

Possible Values:

  • Any string up to 100 characters

Comments

Comments XML Structure

<xsd:simpleType name="Comments">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="5000"/>
    </xsd:restriction>
</xsd:simpleType>

Any general comments that relate to the request, but not specific to the delivery instructions.

Possible values:

  • Any string up to 5000 characters long

CommercialInvoiceDocument

CommercialInvoiceDocument XML Structure

<xsd:simpleType name="CommercialInvoiceDocument">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="1000000"/>
    </xsd:restriction>
</xsd:simpleType>

The commercial invoice document required for international deliveries.

Important: The contents of this field are encoded using base64.

This is done to ensure that the binary data that forms the file’s contents survive transport through the transport layer.

When creating a file from this field’s contents you will need to ensure that you decode using base64.

CommercialInvoiceDocumentType

CommercialInvoiceDocumentType XML Structure

<xsd:simpleType name="TrackingDocumentType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="application/pdf"/>
        <xsd:enumeration value="application/msword"/>
        <xsd:enumeration value="application/excel"/>
    </xsd:restriction>
</xsd:simpleType>

The type of commercial invoice document.

These types are the standard Multipurpose Internet Mail Extensions (MIME) as defined by the Internet Engineering Task Force (IETF) (please refer to http://www.mimetype.org/).

Possible Values:

  • application/pdf - Adobe PDF document (.pdf)
  • application/msword - Microsoft Word document (.doc)
  • application/excel - Microsoft Excel Spreadsheet (.xls)

Example: application/pdf

CompanyName

CompanyName XML Structure

<xsd:simpleType name="CompanyName">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="100"/>
    </xsd:restriction>
</xsd:simpleType>

The name of a company.

Possible Values:

  • Any string up to 100 characters long

CompanyNumber

CompanyNumber XML Structure

<xsd:simpleType name="CompanyNumber">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="30"/>
    </xsd:restriction>
</xsd:simpleType>

The number issued by the governing body (either at a state or federal level) responsible for the registration and renewal of a company’s details.

For example in Australia the number issued by ASIC is an ABN (Australian Business Number).

Possible Values:

  • Any string up to 30 characters long which is a valid number for the company.

Composition

Composition XML Structure

<xsd:simpleType name="Composition">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="100"/>
    </xsd:restriction>
</xsd:simpleType>

The material composition of the items being sent.

Possible Values:

  • Any string with up to 100 characters

Example: 50% cotton, 50% polyester

ConsignmentDocument

ConsignmentDocument XML Structure

<xsd:simpleType name="ConsignmentDocument">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="1000000"/>
    </xsd:restriction>
</xsd:simpleType>

The carrier’s consignment document.

Important: The contents of this field are encoded using base64.

This is done to ensure that the binary data that forms the file’s contents survive transport through the transport layer.

When creating a file from this field’s contents you will need to ensure that you decode using base64.

ConsignmentDocumentType

ConsignmentDocumentType XML Structure

<xsd:simpleType name="ConsignmentDocumentType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="application/pdf"/>
        <xsd:enumeration value="application/msword"/>
        <xsd:enumeration value="application/excel"/>
    </xsd:restriction>
</xsd:simpleType>

The type of consignment document.

These types are the standard Multipurpose Internet Mail Extensions (MIME) as defined by the Internet Engineering Task Force (IETF) (please refer to http://www.mimetype.org/).

Possible Values:

  • application/pdf - Adobe PDF document (.pdf)
  • application/msword - Microsoft Word document (.doc)
  • application/excel - Microsoft Excel Spreadsheet (.xls)

Example: application/pdf

ConsignmentNumber

ConsignmentNumber XML Structure

<xsd:simpleType name="ConsignmentNumber">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The carrier’s consignment number identifies a logical grouping of goods that has been consigned.

Possible Values:

  • Any string up to 50 characters long

ContactName

ContactName XML Structure

<xsd:simpleType name="ContactName">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="100"/>
    </xsd:restriction>
</xsd:simpleType>

The name of an individual who is the contact for a company.

Possible Values:

  • Any string up to 100 characters long

ContainerDimensions

ContainerDimensions XML Structure

<xsd:simpleType name="ContainerDimensions">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="20FT"/>
        <xsd:enumeration value="40FT"/>
        <xsd:enumeration value="48FT"/>
    </xsd:restriction>
</xsd:simpleType>

The dimensions of the container being sent.

Possible values:

  • 20FT
  • 40FT
  • 48FT

ContainerNature

ContainerNature XML Structure

<xsd:simpleType name="ContainerNature">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Shipping Container"/>
        <xsd:enumeration value="Flat Rack"/>
        <xsd:enumeration value="Open Top Container"/>
        <xsd:enumeration value="High Cube"/>
        <xsd:enumeration value="Curtin Sider"/>
    </xsd:restriction>
</xsd:simpleType>

The nature of the container being sent.

Possible values:

  • Shipping Container
  • Flat Rack
  • Open Top Container
  • High Cube
  • Curtin Sider

CountryCode

CountryCode XML Structure

<xsd:simpleType name="CountryCode">
    <xsd:restriction base="xsd:string">
        <xsd:pattern value="[A-Z]{2}"/>
    </xsd:restriction>
</xsd:simpleType>

The 2 letter code representing a country as specified by ISO 3166 (International Standards Organisation – http://www.iso.org).

CreditCardExpiryDate

CreditCardExpiryDate XML Structure

<xsd:simpleType name="CreditCardExpiryDate">
    <xsd:restriction base="xsd:string">
        <xsd:pattern value="(0[1-9]|1[012])-20[0-9]{2}"/>
    </xsd:restriction>
</xsd:simpleType>

The expiry date of the credit card being supplied, for credit card payments.

Example: 05-2010

CreditCardName

CreditCardName XML Structure

<xsd:simpleType name="CreditCardName">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The name of the owner of the credit card (as specified on the card) being supplied, for credit card payments.

Possible Values:

  • Any string up to 50 characters long

CreditCardNumber

CreditCardNumber XML Structure

<xsd:simpleType name="CreditCardNumber">
    <xsd:restriction base="xsd:string">
        <xsd:pattern value="[0-9]{16}"/>
    </xsd:restriction>
</xsd:simpleType>

The number of the credit card being supplied, for credit card payments.

Possible Values:

  • Any 16 digit long numeric string

CreditCardType

CreditCardType XML Structure

<xsd:simpleType name="CreditCardType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="MasterCard"/>
        <xsd:enumeration value="Visa"/>
    </xsd:restriction>
</xsd:simpleType>

The type of credit card being supplied, for credit card payments.

Possible Values:

  • MasterCard
  • Visa

Cubic

Cubic XML Structure

<xsd:simpleType name="Cubic">
    <xsd:restriction base="xsd:decimal">
        <xsd:totalDigits value="8"/>
        <xsd:fractionDigits value="4"/>
        <xsd:maxInclusive value="9999.9999"/>
        <xsd:minInclusive value="0"/>
    </xsd:restriction>
</xsd:simpleType>

The representation of a cubic value, which is the result of the multiplication of the length, width and height of an object.

For example, an object of length 0.5m, width 0.2m and height 0.1m would have a cubic value of 0.01m3 (ie. 0.5 x 0.2 x 0.1).

Example: 0.01

CurrencyAmount

CurrencyAmount XML Structure

<xsd:simpleType name="CurrencyAmount">
    <xsd:restriction base="xsd:decimal">
        <xsd:totalDigits value="8"/>
        <xsd:fractionDigits value="2"/>
        <xsd:maxInclusive value="999999.99"/>
        <xsd:minInclusive value="-999999.99"/>
    </xsd:restriction>
</xsd:simpleType>

The representation of a monetary amount, excluding currency symbols or country codes, as used in Australia.

Possible Values:

  • Any decimal integer between -999999.99 and 999999.99

Back

CurrencyType

CurrencyType XML Structure

<xsd:simpleType name="CurrencyType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="AUD"/>
    </xsd:restriction>
</xsd:simpleType>

The 3 letter code representing a currency code as defined within ISO 4217 (ie. International Standards Organisation – http://www.iso.org). Note: currently only the Australian currency is available.

Possible Values:

  • AUD

DangerousGoodsClass

DangerousGoodsClass XML Structure

<xsd:simpleType name="DangerousGoodsClass">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="5"/>
    </xsd:restriction>
</xsd:simpleType>

The dangerous goods class for the items being sent. Regulatory frameworks incorporate comprehensive classification systems of hazards to provide a taxonomy of dangerous goods.

Classification of dangerous goods is broken down into nine classes according to the type of danger materials or items present:

Possible Values:

  • 1 - Explosives
  • 2 - Gases
  • 3 - Flammable Liquids
  • 4 - Flammable Solids
  • 5 - Oxidizing Substances
  • 6 - Toxic & Infectious Substances
  • 7 - Radioactive Material
  • 8 - Corrosives
  • 9 - Miscellaneous Dangerous Goods

Example: 1

DangerousGoodsPackagingGroup

DangerousGoodsPackagingGroup XML Structure

<xsd:simpleType name="DangerousGoodsPackagingGroup">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="5"/>
    </xsd:restriction>
</xsd:simpleType>

The dangerous goods packaging group type for the item/s being sent. A Packing Group is assigned to dangerous goods according to the degree of hazard they present.

Possible Values:

  • Any string up to 5 characters long

Date

Date XML Structure

<xsd:simpleType name="Date">
    <xsd:restriction base="xsd:string">
        <xsd:pattern value="20[0-9]{2}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])"/>
    </xsd:restriction>
</xsd:simpleType>

A date specified using the international format defined by ISO 8601 (ie. International Standards Organisation – http://www.iso.org) which follows the numerical date system as follows: YYYY-MM-DD.

Example: for 2nd March, 2009 use 2009-03-02

Back

Datetime

Datetime XML Structure

<xsd:simpleType name="Datetime">
    <xsd:restriction base="xsd:string">
        <xsd:pattern value="20[0-9]{2}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01]) T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]Z"/>
    </xsd:restriction>
</xsd:simpleType>

A datetime specified using the international format defined by ISO 8601 (ie. International Standards Organisation – http://www.iso.org) which follows the numerical date system as follows: YYYY-MM-DDThh:mm:ssZ. The datetime provided will be a Coordinated Universal Time (UTC), see http://en.wikipedia.org/wiki/Coordinated_Universal_Time for further details.

Example: for 2:26pm and 12 seconds on the 2nd March, 2009 use 2009-03-02T14:26:12Z

Back

DeliveryMethod

DeliveryMethod XML Structure

<xsd:simpleType name="DeliveryMethod">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The method used for transporting an item.

Possible Values:

  • Any string up to 50 characters long

DeliveryNature

DeliveryNature XML Structure

<xsd:simpleType name="DeliveryNature">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Domestic"/>
        <xsd:enumeration value="International"/>
    </xsd:restriction>
</xsd:simpleType>

Whether the item is being sent domestically (ie. within the same country) or internationally (from one country to another).

Possible values:

  • Domestic
  • International

DeliveryType

DeliveryType XML Structure

<xsd:simpleType name="DeliveryType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Door to Door"/>
        <xsd:enumeration value="Depot to Depot"/>
        <xsd:enumeration value="Port to Port"/>
    </xsd:restriction>
</xsd:simpleType>

The delivery method for the item being sent.

Possible values:

  • Door to Door
  • Depot to Depot
  • Port to Port

DepotInstructions

DepotInstructions XML Structure

<xsd:simpleType name="DepotInstructions">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="5000"/>
    </xsd:restriction>
</xsd:simpleType>

The instructions for dropping off or receiving items from a carrier’s depot.

Possible Values:

  • Any string up to 5000 characters long

DepotName

DepotName XML Structure

<xsd:simpleType name="DepotName">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The name of a carrier’s depot location.

Possible Values:

  • Any string up to 50 characters long

Detail

Detail XML Structure

<xsd:simpleType name="Detail">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Detailed"/>
        <xsd:enumeration value="Summary"/>
    </xsd:restriction>
</xsd:simpleType>

The amount of information to be returned.

Possible Values:

  • Detailed - all available information.
  • Summary - limited amount of information.

Example: Detailed

DistanceMeasurementType

DistanceMeasurementType XML Structure

<xsd:simpleType name="DistanceMeasurementType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Centimetres"/>
        <xsd:enumeration value="Metres"/>
        <xsd:enumeration value="Inches"/>
        <xsd:enumeration value="Feet"/>
    </xsd:restriction>
</xsd:simpleType>

The distance measurement type to be used for the Length, Width and Height values.

Possible values:

  • Centimetres
  • Metres
  • Inches
  • Feet

Documents

Documents XML Structure

<xsd:complexType name="Documents">
    <xsd:all>
        <xsd:element name="articleLabels" type="tns:YesNoOption" minOccurs="0" maxOccurs="1"/>
    </xsd:all>
</xsd:complexType>

Documents Example

<documents>
    <articleLabels>Y</articleLabels>
</documents>

With the above example, the following child elements will no longer be provided

<articles>
    <article>
        <labelDocument/>
        <labelDocumentType/>
    </article>
</articles>

Please note that the articleNumber and anythingIndex child elements will still be provided

A list of yes/no options for documentation types.

EAN

EAN XML Structure

<xsd:simpleType name="EAN">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="13"/>
    </xsd:restriction>
</xsd:simpleType>

An EAN-13 barcode (originally European Article Number, but now renamed International Article Number even though the abbreviation EAN has been retained) is a 13 digit (12 data and 1 check) barcoding standard which is a superset of the original 12-digit Universal Product Code (UPC) system developed in the United States. The EAN-13 barcode is defined by the standards organization GS1.

Possible Values:

  • Any string up to 13 characters long

Email

Email XML Structure

<xsd:simpleType name="Email">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="500"/>
    </xsd:restriction>
</xsd:simpleType>

An e-mail address identifying a location to which e-mail messages can be delivered.

Possible Values:

  • Any string up to 500 characters long

Eta

Eta XML Structure

<xsd:simpleType name="Eta">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1"/>
        <xsd:maxInclusive value="999999999"/>
    </xsd:restriction>
</xsd:simpleType>

The number of days estimated for delivery.

Possible Values:

  • Any integer between 1 and 999999999

ExtraDetails

ExtraDetails XML Structure

<xsd:simpleType name="ExtraDetails">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="500"/>
    </xsd:restriction>
</xsd:simpleType>

The details of an extra available for a quote.

Possible Values:

  • Any string up to 500 characters long

Example: Insurance cover up to $5,000.

ExtraSummary

ExtraSummary XML Structure

<xsd:simpleType name="ExtraSummary">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="100"/>
    </xsd:restriction>
</xsd:simpleType>

The summary of the details relating to an extra available for a quote.

Possible Values:

  • Any string up to 100 characters long

Example: Insurance

Fax

Fax XML Structure

<xsd:simpleType name="Fax">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

A fax number.

Possible Values:

  • Any string up to 50 characters long

Firstname

Firstname XML Structure

<xsd:simpleType name="Firstname">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

An individual’s first name.

Possible Values:

  • Any string up to 50 characters long

GeneratedType

GeneratedType XML Structure

<xsd:simpleType name="GeneratedType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Manually"/>
        <xsd:enumeration value="Automatically"/>
    </xsd:restriction>
</xsd:simpleType>

How a quote was generated, either automatically or manually.

Possible Values:

  • Automatically - price created based on the carrier’s pre-recorded rates.
  • Manually - the carrier has reviewed the request and then provided a price.

Example: Automatically

Height

Height XML Structure

<xsd:simpleType name="Height">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1"/>
    </xsd:restriction>
</xsd:simpleType>

The height of the item being sent.

Possible values:

  • Any integer greater than or equal to 1

HS

HS XML Structure

<xsd:simpleType name="HS">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="12"/>
    </xsd:restriction>
</xsd:simpleType>

The Harmonized Commodity Description and Coding System (HS) of tariff nomenclature is an internationally standardized system of names and numbers for classifying traded products developed and maintained by the World Customs Organization (WCO).

Possible Values:

  • Any string up to 12 characters long

HS6Digit

HS6Digit XML Structure

<xsd:simpleType name="HS6Digit">
    <xsd:restriction base="xsd:string">
        <xsd:minLength value="6"/>
        <xsd:maxLength value="6"/>
    </xsd:restriction>
</xsd:simpleType>

The first 6 digits of the Harmonized Commodity Description and Coding System (HS). This is normally provided to allow the Temando system to calculate the full code.

Possible Values:

  • Any string exactly 6 characters long

InclusionDetails

InclusionDetails XML Structure

<xsd:simpleType name="InclusionDetails">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="500"/>
    </xsd:restriction>
</xsd:simpleType>

The details of an inclusion for a quote.

Possible Values:

  • Any string up to 500 characters long

Example: Tracking information will be available for this quote.

InclusionSummary

InclusionSummary XML Structure

<xsd:simpleType name="InclusionSummary">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="100"/>
    </xsd:restriction>
</xsd:simpleType>

The summary of the details relating to an inclusion for a quote.

Possible Values:

  • Any string up to 100 characters long

Example: Tracking available

IndividualCompany

IndividualCompany XML Structure

<xsd:simpleType name="IndividualCompany">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Individual"/>
        <xsd:enumeration value="Company"/>
    </xsd:restriction>
</xsd:simpleType>

Whether a client account is for an individual or a proprietary company.

Possible Values:

  • Individual - individual person.
  • Company - proprietary company.

Example: Individual

Instructions

Instructions XML Structure

<xsd:simpleType name="Instructions">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="30"/>
    </xsd:restriction>
</xsd:simpleType>

Instructions to be printed on any consignment note or booking sheet that are to be provided to the carrier agent. Note: these should only be instructions that are not available as options, eg. do not specify “unattended delivery” as the fields “destinationResUnattended” or “destinationBusUnattended” in Anywhere already provide this information.

Possible values:

  • Any string up to 30 characters long

ISBN

ISBN XML Structure

<xsd:simpleType name="ISBN">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="13"/>
    </xsd:restriction>
</xsd:simpleType>

The International Standard Book Number (ISBN) is a unique numeric commercial book identifier.

Possible Values:

  • Any string up to 13 characters long

ItemDescription

ItemDescription XML Structure

<xsd:simpleType name="ItemDescription">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="1000"/>
    </xsd:restriction>
</xsd:simpleType>

Further details of the item being sent, that have not been specified in other elements.

Possible values:

  • Any string up to 1000 characters long

LabelDocument

LabelDocument XML Structure

<xsd:simpleType name="LabelDocument">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="1000000"/>
    </xsd:restriction>
</xsd:simpleType>

The carrier’s label document.

Important: The contents of this field are encoded using base64. This is done to ensure that the binary data that forms the file’s contents survive transport through the transport layer. When creating a file from this field’s contents you will need to ensure that you decode using base64.

LabelDocumentType

LabelDocumentType XML Structure

<xsd:simpleType name="LabelDocumentType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="application/pdf"/>
        <xsd:enumeration value="application/msword"/>
        <xsd:enumeration value="application/excel"/>
        <xsd:enumeration value="application/text"/>
    </xsd:restriction>
</xsd:simpleType>

The type of label document.

These types are the standard Multipurpose Internet Mail Extensions (MIME) as defined by the Internet Engineering Task Force (IETF) (please refer to http://www.mimetype.org/).

Possible Values:

  • application/pdf - Adobe PDF document (.pdf)
  • application/msword - Microsoft Word document (.doc)
  • application/excel - Microsoft Excel Spreadsheet (.xls)
  • application/text - Raw ZPL file (.zpl)

Example: application/pdf

LabelPrinterType

LabelPrinterType XML Structure

<xsd:simpleType name="LabelPrinterType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Thermal"/>
        <xsd:enumeration value="Standard"/>
        <xsd:enumeration value="ZPL"/>
    </xsd:restriction>
</xsd:simpleType>

The type of printer that will be used to print the label.

Possible Values:

  • Thermal - for thermal label printers.
  • Standard - general laser printers.
  • ZPL - general ZPL printers.

Example: Standard

Length

Length XML Structure

<xsd:simpleType name="Length">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1"/>
    </xsd:restriction>
</xsd:simpleType>

The length of the item being sent.

Possible values:

  • Any integer greater than or equal to 1

LineItemReference

LineItemReference XML Structure

<xsd:simpleType name="LineItemReference">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="20"/>
    </xsd:restriction>
</xsd:simpleType>

The line item reference for multiple products being submitted in the same order.

Possible Values:

  • Any string with up to 20 characters

LivestockType

LivestockType XML Structure

<xsd:simpleType name="LivestockType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Cattle"/>
        <xsd:enumeration value="Horse"/>
        <xsd:enumeration value="Sheep"/>
        <xsd:enumeration value="Pig"/>
        <xsd:enumeration value="Other"/>
    </xsd:restriction>
</xsd:simpleType>

The type of the livestock being sent.

Possible values:

  • Cattle
  • Horse
  • Sheep
  • Pig
  • Other

LocationName

LocationName XML Structure

<xsd:simpleType name="LocationName">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="20"/>
    </xsd:restriction>
</xsd:simpleType>

The description allocated to a predefined location stored in the client’s location listings.

Possible Values:

  • Any string up to 20 characters long

LocationPosition

LocationPosition XML Structure

<xsd:simpleType name="LocationPosition">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Origin"/>
        <xsd:enumeration value="Destination"/>
    </xsd:restriction>
</xsd:simpleType>

Whether a location is an originating address (pickup) or a destination address (dropoff).

Possible Values:

  • Origin - an originating address (pickup)
  • Destination - a destination address (dropoff)

LocationSelection

LocationSelection XML Structure

<xsd:simpleType name="LocationSelection">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Priority"/>
        <xsd:enumeration value="Nearest"/>
        <xsd:enumeration value="Nearest by Priority"/>
        <xsd:enumeration value="Most Stock"/>
    </xsd:restriction>
</xsd:simpleType>

If an origin location is not supplied what process should be used to select the location?

Possible Values:

  • Priority - based on the priority number allocated to the location.
  • Nearest - based on which location is the closest to the destination location.
  • Nearest by Priority
  • Most Stock - based on which location has the most stock.

Example: Priority

LocationType

LocationType XML Structure

<xsd:simpleType name="LocationType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Residence"/>
        <xsd:enumeration value="Business"/>
    </xsd:restriction>
</xsd:simpleType>

What type of location is either sending an item or receiving it.

Possible Values: * Residence * Business

LoginId

LoginId XML Structure

<xsd:simpleType name="LoginId">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

Login id for an account.

Possible Values:

  • Any string up to 50 characters long

ManifestDocument

ManifestDocument XML Structure

<xsd:simpleType name="ManifestDocument">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="1000000"/>
    </xsd:restriction>
</xsd:simpleType>

The carrier’s manifest document.

Important: The contents of this field are encoded using base64. This is done to ensure that the binary data that forms the file’s contents survive transport through the transport layer. When creating a file from this field’s contents you will need to ensure that you decode using base64.

ManifestDocumentType

ManifestDocumentType XML Structure

<xsd:simpleType name="ManifestDocumentType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="application/pdf"/>
        <xsd:enumeration value="application/msword"/>
        <xsd:enumeration value="application/excel"/>
    </xsd:restriction>
</xsd:simpleType>

The type of consignment document.

These types are the standard Multipurpose Internet Mail Extensions (MIME) as defined by the Internet Engineering Task Force (IETF) (please refer to http://www.mimetype.org/).

Possible Values:

  • application/pdf - Adobe PDF document (.pdf)
  • application/msword - Microsoft Word document (.doc)
  • application/excel - Microsoft Excel Spreadsheet (.xls)

Example: application/pdf

ManifestNumber

ManifestNumber XML Structure

<xsd:simpleType name="ManifestNumber">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The carrier’s manifest number identifies a logical grouping of consignments.

Possible Values:

  • Any string up to 50 characters long

ManifestType

ManifestType XML Structure

<xsd:simpleType name="ManifestType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Awaiting Confirmation"/>
        <xsd:enumeration value="Confirmed"/>
    </xsd:restriction>
</xsd:simpleType>

The type of manifest report to be generated.

Possible Values:

  • Awaiting Confirmation - those requests that have not yet been confirmed.
  • Confirmed - those requests that have been confirmed.

Mode

Mode XML Structure

<xsd:simpleType name="Mode">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Truckload"/>
        <xsd:enumeration value="Less than load"/>
        <xsd:enumeration value="Container"/>
    </xsd:restriction>
</xsd:simpleType>

The mode of the item being sent.

Possible values:

  • Truckload
  • Less than load
  • Container

ModelNumber

ModelNumber XML Structure

<xsd:simpleType name="ModelNumber">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="15"/>
    </xsd:restriction>
</xsd:simpleType>

A number that is specific to a line of products.

Possible Values:

  • Any string up to 15 characters long

MPN

MPN XML Structure

<xsd:simpleType name="MPN">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="15"/>
    </xsd:restriction>
</xsd:simpleType>

A Manufactoring Part Number is an identifier of a particular part design used in a particular industry. Its purpose is to simplify referencing to that part. A part number unambiguously identifies a part design within a single corporation, and sometimes across several corporations.

Possible Values:

  • Any string up to 15 characters long

Packaging

Packaging XML Structure

<xsd:simpleType name="Packaging">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Backpack"/>
        <xsd:enumeration value="Bale"/>
        <xsd:enumeration value="Box"/>
        <xsd:enumeration value="Bunch"/>
        <xsd:enumeration value="Bundle"/>
        <xsd:enumeration value="Carton"/>
        <xsd:enumeration value="Crate"/>
        <xsd:enumeration value="Cylinder"/>
        <xsd:enumeration value="Document Envelope"/>
        <xsd:enumeration value="Drum"/>
        <xsd:enumeration value="Flat Pack"/>
        <xsd:enumeration value="Letter"/>
        <xsd:enumeration value="Pail"/>
        <xsd:enumeration value="Pallet"/>
        <xsd:enumeration value="Parcel"/>
        <xsd:enumeration value="Pipe"/>
        <xsd:enumeration value="Roll"/>
        <xsd:enumeration value="Satchel/Bag"/>
        <xsd:enumeration value="Skid"/>
        <xsd:enumeration value="Suitcase"/>
        <xsd:enumeration value="Tube"/>
        <xsd:enumeration value="Unpackaged or N/A"/>
        <xsd:enumeration value="Wheel/Tyre"/>
    </xsd:restriction>
</xsd:simpleType>

The type of packaging used for the item being sent.

Possible values:

  • Backpack
  • Bale
  • Box
  • Bunch
  • Bundle
  • Carton
  • Crate
  • Cylinder
  • Document Envelope
  • Drum
  • Flat Pack
  • Letter
  • Pail
  • Pallet
  • Parcel
  • Pipe
  • Roll
  • Satchel/Bag
  • Skid
  • Suitcase
  • Tube
  • Unpackaged or N/A
  • Wheel/Tyre

PackagingDescription

PackagingDescription XML Structure

<xsd:simpleType name="PackagingDescription">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="10"/>
    </xsd:restriction>

The unique name for a packaging type to be stored in Temando.

Possible Values:

  • Any string up to 10 characters long

Example: Large Box

PalletNature

PalletNature XML Structure

<xsd:simpleType name="PalletNature">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Exchange"/>
        <xsd:enumeration value="Transfer"/>
        <xsd:enumeration value="Not Required"/>
    </xsd:restriction>
</xsd:simpleType>

The pallet nature being sent..

Possible values:

  • Exchange
  • Transfer
  • Not Required

PalletType

PalletType XML Structure

<xsd:simpleType name="PalletType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Chep"/>
        <xsd:enumeration value="Loscam"/>
        <xsd:enumeration value="Plain"/>
        <xsd:enumeration value="Not Required"/>
    </xsd:restriction>
</xsd:simpleType>

The pallet type being sent.

Possible values:

  • Chep
  • Loscam
  • Plain
  • Not Required

Password

Password XML Structure

<xsd:simpleType name="Password">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="20"/>
    </xsd:restriction>
</xsd:simpleType>

Password for an account.

Possible Values:

  • Any string up to 20 characters long

PaymentType

PaymentType XML Structure

<xsd:simpleType name="PaymentType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Credit Card"/>
        <xsd:enumeration value="Account"/>
        <xsd:enumeration value="Credit"/>
    </xsd:restriction>
</xsd:simpleType>

The payment method to be used for paying for a monetary amount.

Possible Values:

  • Credit Card
  • Account
  • Credit

Phone

Phone XML Structure

<xsd:simpleType name="Phone">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

A telephone number.

Possible Values:

  • Any string up to 50 characters long

PortName

PortName XML Structure

<xsd:simpleType name="PortName">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

A port name used for sending or receiving items for international transportation.

Possible Values: * Any string up to 50 characters long

PortType

PortType XML Structure

<xsd:simpleType name="PortType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Sea"/>
        <xsd:enumeration value="Air"/>
        <xsd:enumeration value="Any"/>
    </xsd:restriction>
</xsd:simpleType>

A port name used for sending or receiving items for international transportation.What type of transportation is supported for a port.

Possible Values:

  • Sea
  • Air
  • Any

PostalCode

PostalCode XML Structure

<xsd:simpleType name="PostalCode">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="10"/>
    </xsd:restriction>
</xsd:simpleType>

A postal code (known in various countries as a post code, postcode, or ZIP code) is a series of letters and/or digits appended to a postal address for the purpose of sorting mail.

Possible Values:

  • Any string up to 10 characters long

Further to the restrictions applied above the following rules will also be applied after the data has passed the XML tests:

  • If address is in Australia: must match exactly (ie. letter for letter but not case sensitive) with the postal codes defined within the Temando system, which are extracted from the Postcode Datafile as provided by Australia Post (https://www.auspost.com.au).

Priority

Priority XML Structure

<xsd:simpleType name="Priority">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1"/>
        <xsd:maxInclusive value="999"/>
    </xsd:restriction>
</xsd:simpleType>

The priority of that should be assigned to a predefined location. Can be assigned at the location level or at an item/location level. The lower the number the higher the priority.

This will apply if a origin location has not been specified and should be selected based on this priority.

Possible Values:

  • Any integer between 1 and 999

PromotionCode

PromotionCode XML Structure

<xsd:simpleType name="PromotionCode">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="10"/>
    </xsd:restriction>
</xsd:simpleType>

Temando code used for promotions or identifying sales representatives.

Possible Values:

  • Any string up to 10 characters long

Quantity

Quantity XML Structure

<xsd:simpleType name="Quantity">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1"/>
    </xsd:restriction>
</xsd:simpleType>

The number of items being sent.

Possible values:

  • Any integer greater than 1

QuotePreference

QuotePreference XML Structure

<xsd:simpleType name="QuotePreference">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Cheapest"/>
        <xsd:enumeration value="Carriers Only"/>
        <xsd:enumeration value="Carrier Order"/>
    </xsd:restriction>
</xsd:simpleType>

The type of filter to be applied to the quote list.

Possible Values:

  • Cheapest - only a single quote be returned, which will be the cheapest quote available. Can be used for getQuotes and makeBooking.
  • Carriers Only - only those quotes that match with the carrier details supplied in the QuoteFilter. Can be used for getQuotes.
  • Carriers Order - only a single quote will be returned based off the order of the carrier details supplied in the QuoteFilter, with the first available quote matching the list being used. Can be used for getQuotes and makeBooking.

Note: Some QuotePreferences are only valid with some CarrierPreferences.

Example: Cheapest

RateName

RateName XML Structure

<xsd:simpleType name="RateName"> 
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The rate classification for an item or a group of items, used for rates calculation.

Possible Values:

  • Any string up to 50 characters long.

Example: Carton

ReadyTime

ReadyTime XML Structure

<xsd:simpleType name="ReadyTime">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="AM"/>
        <xsd:enumeration value="PM"/>
    </xsd:restriction>
</xsd:simpleType>

A period of the day separated into 2 parts.

Possible Values:

  • AM
  • PM

RequestId

RequestId XML Structure

<xsd:simpleType name="RequestId">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The Id of the request

Possible values:

  • Any string up to 50 characters long

RequestStatus

RequestStatus XML Structure

<xsd:simpleType name="RequestStatus">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Awaiting Acceptance"/>
        <xsd:enumeration value="Awaiting Booking"/>
        <xsd:enumeration value="Completed"/>
        <xsd:enumeration value="Cancelled"/>
    </xsd:restriction>
</xsd:simpleType>

The status of an existing request within the Temando system.

Possible Values:

  • Awaiting Acceptance - quote has been accepted. Awaiting request confirmation and payment.
  • Awaiting Booking - quote has been accepted, request confirmed and payment received. Awaiting a booking reference number to be supplied by the carrier (confirming the booking with the carrier)
  • Completed - quote has been accepted, request confirmed, payment received and booking reference assigned by carrier.
  • Cancelled - request has been cancelled. No further action will be taken for this request.

Example: Completed

ResponseExclusions

ResponseExclusions XML Structure

<xsd:complexType name="ResponseExclusions">
    <xsd:all>
        <xsd:element name="documents" type="tns:Documents" minOccurs="0" maxOccurs="1"/>
    </xsd:all>
</xsd:complexType>

ResponseExclusions Example

<responseExclusions>
    <documents>
        <articleLabels>Y</articleLabels>
    </documents>
</responseExclusions>

Provide the ability to exclude elements from the relevant response.

Possible Values:

  • Documentation

Sex

Sex XML Structure

<xsd:simpleType name="Sex">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="M"/>
        <xsd:enumeration value="F"/>
    </xsd:restriction>
</xsd:simpleType>

If an object has a sex then the option of ‘M’ relates to Male and ‘F’ relates to Female.

Possible values:

  • M
  • F

SKU

SKU XML Structure

<xsd:simpleType name="SKU">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="20"/>
    </xsd:restriction>
</xsd:simpleType>

A stock-keeping unit or SKU is a number or code used to identify each unique product or item for sale in a store or other business.

Possible Values:

  • Any string up to 20 characters long

SSCC

SSCC XML Structure

<xsd:simpleType name="SSCC">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="18"/>
    </xsd:restriction>
</xsd:simpleType>

The serial shipping container code (SSCC) is an 18-digit number used to identify logistics units.

Possible Values:

  • Any string up to 18 characters long

State

State XML Structure

<xsd:simpleType name="State">
    <xsd:restriction base="xsd:string">
        <xsd:pattern value="[A-Z]{3}"/>
    </xsd:restriction>
</xsd:simpleType>

The 3 letter code representing a state which is a land area of local government within a country. Sometimes also referred to as a county, province or region.

Further to the restrictions applied above the following rules will also be applied after the data has passed the XML tests:

  • If address is in Australia must be one of the following: QLD, NSW, VIC, ACT, SA, WA, NT or TAS.

StockCount

StockCount XML Structure

<xsd:simpleType name="StockCount">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1"/>
        <xsd:maxInclusive value="999999999"/>
    </xsd:restriction>
</xsd:simpleType>

The number of stock remaining for an item.

Possible Values:

  • Any integer between 1 and 999999999

StockStatus

StockStatus XML Structure

<xsd:simpleType name="StockStatus">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="IN_STOCK"/>
        <xsd:enumeration value="LIMITED"/>
        <xsd:enumeration value="OUT_OF_STOCK"/>
        <xsd:enumeration value="NEVER"/>
        <xsd:enumeration value="CALL"/>
    </xsd:restriction>
</xsd:simpleType>

The status of a predefined item. This status can be assigned at an item level or based on a given predefined location.

Possible Values:

  • IN_STOCKthe item is in stock and available for deliveries.
  • LIMITEDthe item has limited stock (eg. < 10 items).
  • OUT_OF_STOCKthe item is out of stock and not available for deliveries.
  • NEVERthe item is never available for deliveries.
  • CALLthe item has limited stock (eg. < 10 items).

Example: IN_STOCK

StyleNumber

StyleNumber XML Structure

<xsd:simpleType name="StyleNumber">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="15"/>
    </xsd:restriction>
</xsd:simpleType>

A client specified style number for an item.

Possible Values:

  • Any string up to 15 characters long

Subclass

Subclass XML Structure

<xsd:simpleType name="Subclass">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="20"/>
    </xsd:restriction>
</xsd:simpleType>

The subclass of the item being sent.

Possible values:

  • A string up to 20 characters long

Suburb

Suburb XML Structure

<xsd:simpleType name="Suburb">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

Suburbs are commonly defined as smaller residential communities lying immediately outside a city.

Possible values:

  • Any string up to 100 characters long

Further to the restrictions applied above the following rules will also be applied after the data has passed the XML tests:

  • If address is in Australia: must match exactly (ie. letter for letter but not case sensitive) with the suburb name defined within the Temando system, which are extracted from the Postcode Datafile as provided by Australia Post (https://www.auspost.com.au).

Surname

Surname XML Structure

<xsd:simpleType name="Surname">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

An individual’s surname.

Possible Values:

  • Any string up to 50 characters long

TermsOfTrade

TermsOfTrade XML Structure

<xsd:simpleType name="TermsOfTrade">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Delivered Duty Paid"/>
        <xsd:enumeration value="Delivered Duty Unpaid"/>
    </xsd:restriction>
</xsd:simpleType>

Whether the delivery duty has already been paid or not.

Possible Values:

  • Delivered Duty Paid - duty has been paid
  • Delivered Duty Unpaid - duty has not been paid

Example: Delivered Duty Paid

TlSubclass

TlSubclass XML Structure

<xsd:simpleType name="TlSubclass">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="not required"/>
        <xsd:enumeration value="1"/>
        <xsd:enumeration value="2"/>
        <xsd:enumeration value="3"/>
        <xsd:enumeration value="4"/>
        <xsd:enumeration value="5"/>
        <xsd:enumeration value="6"/>
        <xsd:enumeration value="7"/>
        <xsd:enumeration value="8"/>
        <xsd:enumeration value="9"/>
        <xsd:enumeration value="10"/>
        <xsd:enumeration value="11"/>
        <xsd:enumeration value="12"/>
        <xsd:enumeration value="13"/>
        <xsd:enumeration value="14"/>
        <xsd:enumeration value="15"/>
        <xsd:enumeration value="16"/>
        <xsd:enumeration value="17"/>
        <xsd:enumeration value="18"/>
        <xsd:enumeration value="19"/>
        <xsd:enumeration value="20"/>
    </xsd:restriction>
</xsd:simpleType>

The number of pallets being sent.

Possible values:

  • not required
  • Any number between 1 and 20

TrackingDocument

TrackingDocument XML Structure

<xsd:simpleType name="TrackingDocument">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="1000000"/>
    </xsd:restriction>
</xsd:simpleType>

The carrier’s POD tracking document.

Important: The contents of this field are encoded using base64.

This is done to ensure that the binary data that forms the file’s contents survive transport through the transport layer.

When creating a file from this field’s contents you will need to ensure that you decode using base64.

TrackingDocumentType

TrackingDocumentType XML Structure

<xsd:simpleType name="TrackingDocumentType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="application/pdf"/>
        <xsd:enumeration value="image/jpeg"/>
        <xsd:enumeration value="application/msword"/>
        <xsd:enumeration value="application/excel"/>
    </xsd:restriction>
</xsd:simpleType>

The type of label document.

These types are the standard Multipurpose Internet Mail Extensions (MIME) as defined by the Internet Engineering Task Force (IETF) (please refer to http://www.mimetype.org/).

Possible Values:

  • application/pdf - Adobe PDF document (.pdf)
  • image/jpeg - jpeg document (.jpeg)
  • application/msword - Microsoft Word document (.doc)
  • application/excel - Microsoft Excel Spreadsheet (.xls)

Example: application/pdf

TrackingFurtherDetails

TrackingFurtherDetails XML Structure

<xsd:simpleType name="TrackingFurtherDetails">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="300"/>
    </xsd:restriction>
</xsd:simpleType>

Further details on the transit of the item/s being sent.

Possible Values:

  • Any string up to 300 characters long

Example: Nobody was present at the destination location. Request submitted did not have the unattended option selected, therefore person was required to receive freight. Item currently at the Brisbane depot. Contact carrier for further information.

TrackingStatus

TrackingStatus XML Structure

<xsd:simpleType name="TrackingStatus">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="at waypoint"/>
        <xsd:enumeration value="attempted delivery"/>
        <xsd:enumeration value="attempted delivery (card left)"/>
        <xsd:enumeration value="attempted pick up"/>
        <xsd:enumeration value="awaiting collection"/>
        <xsd:enumeration value="awaiting delivery"/>
        <xsd:enumeration value="awaiting pickup"/>
        <xsd:enumeration value="cancelled"/>
        <xsd:enumeration value="collected"/>
        <xsd:enumeration value="delayed"/>
        <xsd:enumeration value="delivered"/>
        <xsd:enumeration value="delivered (auth to leave)"/>
        <xsd:enumeration value="error/irrelevant"/>
        <xsd:enumeration value="expired parcel"/>
        <xsd:enumeration value="expired parcel collected by courier"/>
        <xsd:enumeration value="expired reservation"/>
        <xsd:enumeration value="in transit"/>
        <xsd:enumeration value="issue occurred"/>
        <xsd:enumeration value="on board for delivery"/>
        <xsd:enumeration value="picked up"/>
        <xsd:enumeration value="returned to sender"/>
        <xsd:enumeration value="unavailable"/>
    </xsd:restriction>
</xsd:simpleType>

The status of the transit of the items being sent.

Example: delivered

UnNumber

UnNumber XML Structure

<xsd:simpleType name="UnNumber">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="5"/>
    </xsd:restriction>
</xsd:simpleType>

The UN number for the material of the item/s being sent. UN numbers or UN IDs are four-digit numbers that identify hazardous substances, and articles (such as explosives, flammable liquids, toxic substances, etc.) in the framework of international transport.

Possible Values:

  • Any string up to 5 characters long

UPC

UPC XML Structure

<xsd:simpleType name="UPC">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="12"/>
    </xsd:restriction>
</xsd:simpleType>

The Universal Product Code (UPC) is a barcode symbology (i.e., a specific type of barcode), that is widely used in North America, and in countries including the UK, Australia, and New Zealand for tracking trade items in stores.

Its most common form, the UPC-A, consists of 12 numerical digits, which are uniquely assigned to each trade item. Along with the related EAN barcode, the UPC is the only barcode allowed for scanning trade items at the point of sale, per GS1 standards. UPC data structures are a component of GTINs (Global Trade Item Numbers). All of these data structures follow the global GS1 standards.

Possible Values:

  • Any string up to 12 characters long

UpdateAction

UpdateAction XML Structure

<xsd:simpleType name="UpdateAction">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Add"/>
        <xsd:enumeration value="Delete"/>
    </xsd:restriction>
</xsd:simpleType>

The type of update action to be performed on a lodged request.

Possible Values:

  • Add - add new Anything elements.
  • Delete - remove individual articles.

VehicleDescription

VehicleDescription XML Structure

<xsd:simpleType name="VehicleDescription">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="100"/>
    </xsd:restriction>
</xsd:simpleType>

The description of the vehicle being sent.

Possible values:

  • Any string up to 100 characters long

VehicleMake

VehicleMake XML Structure

<xsd:simpleType name="VehicleMake">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The make of the vehicle being sent.

Possible values:

  • Any string up to 50 characters long

VehicleModel

VehicleModel XML Structure

<xsd:simpleType name="VehicleModel">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="50"/>
    </xsd:restriction>
</xsd:simpleType>

The model of the vehicle being sent.

Possible values:

  • Any string up to 50 characters long

VehicleRegistration

VehicleRegistration XML Structure

<xsd:simpleType name="VehicleRegistration">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="20"/>
    </xsd:restriction>
</xsd:simpleType>

The registration of the vehicle being sent.

Possible values:

  • Any string up to 20 characters long

VehicleYear

VehicleYear XML Structure

<xsd:simpleType name="VehicleYear">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1920"/>
        <xsd:maxInclusive value="2050"/>
    </xsd:restriction>
</xsd:simpleType>

The year of the vehicle being sent.

Possible values:

  • Any int between 1920 and 2050

Website

Website XML Structure

<xsd:simpleType name="Website">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="300"/>
    </xsd:restriction>
</xsd:simpleType>

A Uniform Resource Locator (URL) that specifies where an identified resource is available and the mechanism for retrieving it.

Possible Values:

  • Any string up to 300 characters long

Weight

Weight XML Structure

<xsd:simpleType name="Weight">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1"/>
    </xsd:restriction>
</xsd:simpleType>

The weight of the item being sent.

Possible values:

  • Any integer greater than or equal to 1

WeightMeasurementType

WeightMeasurementType XML Structure

<xsd:simpleType name="WeightMeasurementType">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Grams"/>
        <xsd:enumeration value="Kilograms"/>
        <xsd:enumeration value="Ounces"/>
        <xsd:enumeration value="Pounds"/>
    </xsd:restriction>
</xsd:simpleType>

The weight measurement type to be used for the Weight values.

Possible values:

  • Grams
  • Kilograms
  • Ounces
  • Pounds

Width

Width XML Structure

<xsd:simpleType name="Width">
    <xsd:restriction base="xsd:int">
        <xsd:minInclusive value="1"/>
    </xsd:restriction>
</xsd:simpleType>

The width of the item being sent.

Possible values:

  • Any integer greater than or equal to 1

YesNoOption

YesNoOption XML Structure

<xsd:simpleType name="YesNoOption">
    <xsd:restriction base="xsd:string">
        <xsd:enumeration value="Y"/>
        <xsd:enumeration value="N"/>
    </xsd:restriction>
</xsd:simpleType>

If an element requires an optional condition then the option of ‘Y’ relates to Yes and ‘N’ relates to No.

Possible values:

  • Y
  • N

Back

ZoneName

ZoneName XML Structure

<xsd:simpleType name="ZoneName">
    <xsd:restriction base="xsd:string">
        <xsd:maxLength value="100"/>
    </xsd:restriction>
</xsd:simpleType>

The name representing a zonal region, used for rates calculation.

Possible Values:

  • Any string up to 100 characters long

Soap Faults

The following faults are generic (ie. can be returned from any operation) unless specified otherwise. In all cases the faultactor will be set to the accessed URL, and the faultstring will contain a human-readable description of the fault’s cause.

In all cases a HTTP response code of 500 is returned with the fault.

Err_Service

Fault codes starting with Err_Service indicate an issue with the Temando API service.

Err_Service01

Err_Service01 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Service01</faultcode>
            <faultstring>The API service is currently unavailable. Please try again later.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the Temando API service is unavailable. This could occur during an upgrade.

Err_Service02

Err_Service02 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Service02</faultcode>
            <faultstring>The API service is currently having problems processing your request – during the authentication process. Please try again later.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the Temando API service has encountered an unknown error whilst processing the call. Details of the specific area of failure is detailed in the element to assist Temando with troubleshooting.

Err_Service03

Err_Service03 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Service03</faultcode>
            <faultstring>The Temando system is experiencing difficults in processing credit card payments. Please try again later.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the Temando API service is unable to process credit card payments. This will normally be a temporary issue.

Err_Connection

Fault codes starting with Err_Connection indicate an issue with the connection or data transfer method used to communication with the Temando API service.

Err_Connection01

Err_Connection01 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Connection01</faultcode>
            <faultstring>Invalid access for service.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the Temando API service is being access using an invalid domain name (eg. https://something.temando.com/soap/).

Err_Connection02

Err_Connection02 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Connection02</faultcode>
            <faultstring>This service can only be view securely, ie. https.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the Temando API service is not being accessed securely. (ie. not https)

Err_Connection03

Err_Connection03 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Connection03</faultcode>
            <faultstring>Invalid access for service.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the Temando API service has not been called via an http post.

Err_Access

Fault codes starting with Err_Access indicate an issue with a user’s access rights to the Temando API service and its operations.

Err_Access01

Err_Access01 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Access01</faultcode>
            <faultstring>The IP address that this service is being called from is not registered for this service.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when a Temando API service is being called from an IP address that is not included in the list of safe IP addresses. Please contact Temando for further details on adding IP addresses to the safe list.

Err_Access02

Err_Access02 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Access02</faultcode>
            <faultstring>Header information containing the Username and Password was either not provided, incomplete or incorrectly formatted.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when a Temando API service call does not contain a header or the information containing the Username and Password was either not provided, incomplete or incorrectly formatted.

See User Authentication for further details on sending authentication details via the Header.

Err_Access03

Err_Access03 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Access03</faultcode>
            <faultstring>The login details you have provided are not a valid Username and Password combination.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the supplied Username and Password are not valid. (eg. incorrect password)

Err_Access04

Err_Access04 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Access04</faultcode>
            <faultstring>The login details you have provided are for an account that has been locked - due to the maximum number of allowed failed login attempts being reached.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the supplied Username and Password correspond to an account that has been locked out of the Temando system – due to the maximum number of allowed failed login attempts being reached.

You will need to contact Temando for further details and to unlock your account.

Err_Access05

Err_Access05 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Access05</faultcode>
            <faultstring>The login details you have provided are for an account that has been locked - due to the account registration awaiting approval by system administrators.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the supplied Username and Password correspond to an account that has been locked out of the Temando system – due to the account registration awaiting approval by system administrators. This fault will only occur when connecting to the system as a Carrier.

You will need to wait for the processing of your registration request before being able to use this service.

Err_Access06

Err_Access06 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Access06</faultcode>
            <faultstring>The login details you have provided are for an account that has been locked - due to inappropriate activities.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the supplied Username and Password correspond to an account that has been locked out of the Temando system – due to inappropriate activities.

You will need to contact Temando for further details and to unlock your account.

Err_Access07

Err_Access07 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Access07</faultcode>
            <faultstring>The login details you have provided are for an account that is not authorised to use the API.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the supplied Username and Password correspond to an account that does not have permission to utilise this service.

You will need to contact Temando to organise the setup of this access right.

Err_Access08

Err_Access08 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Access08</faultcode>
            <faultstring>The login details you have provided are for an account that is not authorised to use the API call 'getQuotes'.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the supplied Username and Password correspond to an account that does not have permission to utilise this service.

You will need to contact Temando to organise the setup of this access right.

Err_Access09

Err_Access09 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Access09</faultcode>
            <faultstring>The login details you have provided are for an account that requires the password to be changed.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the supplied Username and Password correspond to an account that requires the password to be changed. If this exception is generated the user will required to log into the website and change their password before API facilities will be available to them.

Err_Format

Fault codes starting with Err_Format indicate an issue with the format of the data being sent to the Temando API service. This fault is generated when any of the supplied elements contain invalid data.

The specific details of the format issues are detailed in the faultstring element. Some examples of the type of issue strings returned include:

  • The Username element (within the UsernameToken type) does not contain a value. This is a mandatory element.
  • The class element (within the Anything type) does not contain a valid value. The value must be one of the following: Freight, General Goods, Vehicle, Boat, Animal, Refrigerated or Other.
  • The subclass element (within the Anything type) does not contain a valid value. If the ‘class’ element contains a ‘General Goods’ value then this elements value must be one of the following: Household Goods, Excess Baggage, Furniture or Other (Etc.).
  • The Username element (within the UsernameToken type) does not contain a valid value. This must be a string between 1 and 64 characters long.
  • The qualifierVehicleMake, qualifierVehicleModel, qualifierVehicleDescription and qualifierVehicleYear elements (within the Anything type) do not contain valid values. These values must match with the predefined settings in the Temando system.
  • The quantity element (within the Anything type) does not contain a valid value. This must be a number with no more than 5 digits.

Err_Format Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Format</faultcode>
            <faultstring>The Username element (within the UsernameToken type) does not contain a value. This is a mandatory element.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

As this is a generic exception that can be applied to multiple entries and combinations, each Err_Format exception will not be listed in individual sections. However, to assist in error handling the following table summarises the different types that can be thrown.

In the messages listed each entry that is represented as [example] will be replaced by the relevant value that relates to the error being generated.

For example if request was supplied and the class field did not contain a value and this is a mandatory field, then fault code Err_Format01 would be thrown and the message would be “The ‘class’ element (within the ‘anything’ type) does not contain a value. This is a mandatory element.”.

Fault Code Message
Err_Format01 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) does not contain a value. This is a mandatory element.
Err_Format02 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) does not contain a valid value. The value must be one of the following: [list of options].
Err_Format03 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) does not contain a valid value. If the ‘[tag name 2]’ element contains a ‘[value]’ value then this elements value must be one of the following: [list of options].
Err_Format04 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) does not contain a valid value. This must be a string between [minimum number of characters] and [maximum number of characters] characters long.
Err_Format05 The ‘[tag name 1]’ and ‘[tag name 2]’ elements (within the ‘[parent tag name]’ type) do not contain valid values. These values must match with the predefined settings in the Temando system.
Err_Format06 The ‘[tag name 1]’ and ‘[tag name 2]’ and ‘[tag name 3]’ elements (within the ‘[parent tag name]’ type) do not contain valid values. These values must match with the predefined settings in the Temando system.
Err_Format07 The ‘[tag name 1]’ and ‘[tag name 2]’ and ‘[tag name 3]’ and ‘[tag name 4]’ elements (within the ‘[parent tag name]’ type) do not contain valid values. These values must match with the predefined settings in the Temando system.
Err_Format08 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) does not contain a valid value. This must be a number with no more than [maximum number of digits] digits.
Err_Format09 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) contains an invalid value. Dates must be of the format yyyy-mm-dd (eg. for 21st February, 2010 the format would be 2010-02-21).
Err_Format10 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) contains an invalid value. The date provided does not represent a real date.
Err_Format11 The ‘[tag name 1]’ and ‘[tag name 2]’ elements (within the *‘[parent tag name]’ type) contain invalid values. The datetime represented is a date and time before the current date and time.
Err_Format12 The ‘[tag name 1]’ and ‘[tag name 2]’ elements (within the *‘[parent tag name]’ type) contain invalid values. The datetime represented is a date and time more than 5 years in the future. Send dates must not exceed this maximum.
Err_Format13 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) contains an invalid value. Dates must be of the format mm-yyyy (eg. for expiry February, 2010 the format would be 02-2010).
Err_Format14 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) contains an invalid value. The date provided has expired.
Err_Format15 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) contains an invalid value. The card number provided is not a valid number based on the type of card provided.
Err_Format16 The ‘[tag name]’ location you have supplied does not match with the [tag name 2] details provided (ie. Anywhere) to generate the quote price selected.
Err_Format17 The ‘[tag name 1]’ and ‘[tag name 2]’ elements (within the ‘[parent tag name]’ type) contain invalid values. The date and time requested is being
Err_Format18 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) contains an invalid value. The [tag name] supplied is already being used by another account and cannot be used.
Err_Format19 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) contains an invalid value. The date supplied represents a date of birth that is after the current date.
Err_Format20 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) contains an invalid value. The email/s supplied do not represent valid email addresses (Note: multiple email addresses must be separated by a ‘,’ character).
Err_Format21 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) contains an invalid value. The supplied ‘[tag name]’ is already associated with another account and cannot be used.
Err_Format22 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) contains an invalid value. The date represented is a date after the current date.
Err_Format23 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) does not contain a valid value. This must be a number with no more than [maximum number of digits] digits and at most [maximum number of decimals] decimal values.
Err_Format24 The ‘[tag name]’ element (within the ‘[parent tag name]’ type) contains an invalid value. Datetimes must be of the format yyyy-mm-ddTHH:ii:SS (eg. for UTC 7:23pm (and 44seconds) on the 21st February, 2010 the format would be 2010-02-21T19:23:44).
Err_Format25 The ‘[tag name 1]’ element for insurance has been included for the quote however a value has not been supplied for the ‘[tag name 2]’ (within the ‘[parent tag name]’ type). A value must be supplied for the ‘[tag name 2]’ if insurance is to be included as an ‘[tag name 1]’.
Err_Format26 The ‘[tag name 1]’ element for insurance has been included for the quote however a value has not been supplied for the ‘[tag name 2]’ (within the ‘[parent tag name]’ type). A value must be supplied for the ‘[tag name 2]’ if insurance is to be included as an ‘[tag name 1]’.
Err_Format27 The ‘[tag name 1]’ element (within the ‘[parent tag name 1]’ type) contains a description for a location that already exists.
Err_Format28 The ‘[tag name 1]’ element (within the ‘[parent tag name 1]’ type) contains a description for a location that does not exist.

Err_Payment

Fault codes starting with Err_Payment indicate an issue with the payment being processed by the Temando API service.

Err_Payment01

Err_Payment01 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Payment01</faultcode>
            <faultstring>The amount for the quote exceeds the amount of credit remaining. The remaining credit is AUD$23.14.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the payment method nominated by the user is credit and there is insufficient funds remaining in available credit to process this request.

Err_Payment02

Err_Payment02 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Payment02</faultcode>
            <faultstring>You do not have an account available with Temando. Please contact Temando for further details.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the payment method nominated by the user is account and they do not have account facilities enabled.

Err_Payment03

Err_Payment03 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Payment03</faultcode>
            <faultstring>The amount for the quote exceeds the amount of available funds left in your account. The remaining funds are AUD$23.14.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the payment method nominated by the user is account and the amount of the request will result in the total amount for transactions (for the account period) exceeding their allowed maximum.

Err_Payment04

Err_Payment04 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Payment04</faultcode>
            <faultstring>The credit card payment has been declined. This could be due to invalid details or insufficient funds.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when the payment method nominated by the user is credit card and either the details were invalid or there are insufficient funds.

Err_Permission

Fault codes starting with Err_Permission indicate an issue with the user’s permission to access certain data via the Temando API service.

Err_Permission01

Err_Permission01 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Permission01</faultcode>
            <faultstring>The Origin location you have supplied has been flagged by Temando and items are prevented from being sent to and received from this location. If you require further information on this please contact Temando.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when a specific address (either the origin or destination) has been flagged by Temando and items are prevented from being sent to and received from this location.

Err_Permission02

Err_Permission02 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Permission02</faultcode>
            <faultstring>You do not have permission to access the request associated with the supplied reference.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when a user attempts to access information relating to a request that is not related to their account.

Err_State

Fault codes starting with Err_State indicate an issue with the user attempting to perform an operation on data that does not exist or is not in the correct state for process. This error code if often caused by using an account with invalid access rights.

Err_State01

Err_State01 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_State01</faultcode>
            <faultstring>A request with the supplied reference does not exist or does not contain all the necessary details.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when a user attempts to access information relating to a request that does not exist or is incomplete.

Err_State02

Err_State02 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_State02</faultcode>
            <faultstring>The request associated with the supplied reference was not generated via the API and can not be processed via this API access right.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when a user attempts to access information relating to a request that is not accessible via the Temando API service. An example of when this may occur is if a request is created via the website and then attempting to access this request via an API operation.

Err_State03

Err_State03 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_State03</faultcode>
            <faultstring>The request associated with the supplied reference does not have the correct status for the call requesting it. The current status of this request is [current status]. For the call used the request must have a status of [required status].</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when a user attempts to access information relating to a request or perform some other action on the request when the request does not have the correct status for the operation being called from the Temando API service. An example of when this may occur is if a request has been completed (ie. paid) and the user has attempted to make a payment against this request.

Err_State04

Err_State04 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_State04</faultcode>
            <faultstring>The promotion code provided does not exist, is not available via this service or has expired and is no longer available.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

This fault is generated when a user attempts to use a promotion code that: * does not exist * is not available via this service (i.e. API) * has expired or is no longer available

Err_State05

Err_State05 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_State05</faultcode>
            <faultstring>The quote selected for the booking does not match with an available quote based on the provided details (ie. Anything, Anywhere and Anytime). If you have selected the quote from the getQuotes call it is possible that the quote is no longer available. If not, please check that the details of the booking quote match EXACTLY (ie. case-sensitive) with those of the corresponding available quote selected.</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

Thrown by makeBooking.

This fault is generated when a user attempts to book a quote and the details of the quote to book do not match with any available quotes within the Temando system. The 2 main reasons why this could occur are:

  • The supplied quote is no longer available (ie. the Carrier has changed their pricing details since the getQuotes was made)
  • The details of the supplied quote do not match exactly (ie. is case-sensitive) with the quote supplied from the getQuotes call.

Err_State11

Err_State11 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_State11</faultcode>
            <faultstring>The extra supplied for the booking does not match with an available extra based on the provided details (ie. Anything, Anywhere, Anytime and General). If you have selected the extra from the getQuotes call it is possible that the extra is no longer available. If not, please check that the details of the booking extra match EXACTLY (ie. case-sensitive) with those of the corresponding available quote selected. </faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

Thrown by makeBooking.

This fault is generated when a user attempts to book a quote and the details of an extra to be included does not match with any available extras within the Temando system. The 2 main reasons why this could occur are:

  • The supplied extra is no longer available (ie. the insurance conditions have changed since the getQuotes was made)
  • The details of the supplied extra do not match exactly (ie. is case-sensitive) with the quote supplied from the getQuotes call.

Err_State12

Err_State12 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_State12</faultcode>
            <faultstring>More than one request with the supplied reference exists. For this call this identifier must be unique. </faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

Thrown by getRequest, cancelRequest.

This fault is generated when a user attempts to access information relating to a request using a client specified reference and the reference is associated with more than one request (ie. is not unique).

Err_Data

Err_Data01

Err_Data01 Example

<?xml version="1.0" encoding="UTF-8"?>
<soap-env:Envelope xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
    <soap-env:Body>
        <soap-env:Fault>
            <faultcode>soap-env:Err_Data01</faultcode>
            <faultstring>Unable to send on the specified date and/or at the location because: New Years Day (Australian public holiday).</faultstring>
            <faultactor>http://www.temando.com/soap</faultactor>
        </soap-env:Fault>
    </soap-env:Body>
</soap-env:Envelope>

Thrown by getQuotes, makeBooking.

This fault is generated when a user attempts to supply details that match with an unavailable date and/or location for pickup or drop off at a depot. This may occur if services are not provided on specific days or dates for a given location.

Examples:

  • General freight services are not available on Saturdays or Sundays.
  • There is a general public holiday on the 01/01/2010 in Australia for New Year’s Day and no services are available on this date.
  • There is a general public holiday on the 14/06/2010 in Queensland, Australia for the Queen’s Birthday and no services are available on this date for this state. All other states (eg. NSW, Victoria, etc) are unaffected.