null

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »

What is Web Service Call

EFM use SOAP Web Service Calls which is a method of communicating to an application and the data it has available.

Why Use Web Service Calls

The purpose of these Web Services is to allow you to create/modify/review your existing order processing system to extend its functionality to include a despatching component for your orders. It is assumed that the data required for creating a consignment will already exists in some capacity within one of your systems and as a result this data can be formatted for the purpose of transitioning order data into consignment data.

Web Service WSDL

Our Web Service Definition Language(WSDL) provides a complete overview of all calls that can be made through our SOAP Web Service, as well as the requirements of each call.7

http://support-ws.azurewebsites.net/Data/ChainIT/DataService.svc?wsdl

Tip

Use the WSDL and SoapUI to test your own Web Service Calls

  1. Download & Install SoapUI: https://www.soapui.org/downloads/soapui.html
  2. Open SoapUI
  3. Click “SOAP”: Create your own SOAP Web Service Calls From the WSDL provided.
  4. Enter the WSDL URL: http://support-ws.azurewebsites.net/Data/ChainIT/DataService.svc?wsdl

*SoapUI Is not required to perform Web Service Calls, however this can aid significantly in interpreting the WSDL and understanding the information requirements of each call.

Other Possible Applications

*Using non-SOAP specific applications will require additional Configuration.

Web Service Schema

Below is an XSD Schema which will inform you of the requirements of every Call

http://support-ws.azurewebsites.net/Data/ChainIT/DataService.svc?xsd=xsd0

Making a Web Service Call

To make a call you will need to know 3 thinks

Where you are sending the information?

What you are planning to do?

i.e What function are you calling?

*SoapUI automatically configures the "Header" based on the call being made. However for other applications it is critical the correct SoapAction Url is entered in to make the correct call

What information you are sending

Body:

SOAP Web Service Call Body Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
<!-- Requirements of each soapAction can be found http://support-ws.azurewebsites.net/Data/ChainIT/DataService.svc?xsd=xsd0 -->

				<!-- Example XSD Schema available for Login

					<xs:element name="Login">
						<xs:complexType>
							<xs:sequence>
								<xs:element minOccurs="0" name="userName" nillable="true" type="xs:string"/>
								<xs:element minOccurs="0" name="password" nillable="true" type="xs:string"/>
							</xs:sequence>
						</xs:complexType>
				</xs:element> 

				Example XSD Schema available for Login -->

<!--Below Content Dependent on soapAction Selected  -->

      <cha:Login>
         <!--Optional:-->
         <cha:userName>test@oneflo</cha:userName>
         <!--Optional:-->
         <cha:password>efm123</cha:password>
      </cha:Login>


   </soapenv:Body>
</soapenv:Envelope>

*SoapUI automatically configures the Body Template based on the call being made. If you are using other applications you can use the "Example Body" from the required function definition below. Alternatively consult the Web Service Schema XSD (Link provided above)

Web Service Functions/Calls

Function Definition (Table Format)

CancelConsignment

This process has implemented to allow consignments to be cancelled if a consignment has been saved with incorrect data or if the consignment is no longer required. The function requires a valid Session Key and the ConsignmentID of an un-manifested consignment. If the cancellation is successful the function will return a Boolean value.**

Element

Type

Optional / Mandatory

Length

Comments

session

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

consignmentID

Long

M

20

This is the unique identification number applied to the consignment. Note** This number is different to the Consignment Note sequence.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:CancelConsignment>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:consignmentID>?</cha:consignmentID>
      </cha:CancelConsignment>
   </soapenv:Body>
</soapenv:Envelope>
</soapenv:Envelope>

ConsignmentTrackSearch

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

connoteReference

String

M

20

Use this string to query for consignments that match based on their references

consignmentDate

DateTime

M


This value represents the date the consignment was created.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:ConsignmentTrackingSearch>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:connoteReference>?</cha:connoteReference>
         <!--Optional:-->
         <cha:consignmentDate>?</cha:consignmentDate>
      </cha:ConsignmentTrackingSearch>
   </soapenv:Body>
</soapenv:Envelope>

ConsignmentTrackingSearchByDistributorByAccount

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

connoteReference

String

M

20

Use this string to query for consignments that match based on their references

consignmentDate

DateTime

M


This value represents the date the consignment was created.

distributorId

Int

M

10

This value represents your assigned distributor and can be found as a property in your Session object.

accountId

Int

M

10

This value represents your assigned account id and can be found as a property in your Session object.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:ConsignmentTrackingSearchByDistributorByAccount>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:connoteReference>?</cha:connoteReference>
         <!--Optional:-->
         <cha:consignmentDate>?</cha:consignmentDate>
         <!--Optional:-->
         <cha:distributorId>?</cha:distributorId>
         <!--Optional:-->
         <cha:accountId>?</cha:accountId>
      </cha:ConsignmentTrackingSearchByDistributorByAccount>
   </soapenv:Body>
</soapenv:Envelope>

CreateConsolidatedBooking

In some circumstances it may be required to auto book all consignments, particularly for return consignments. This function requires and valid Session Key and a valid DateTime for the pickup date. The function will return a Booking Notification object that will contain a ConfirmationID if successful or ResponseError message if the booking has failed.

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

pickupDate

string

M

10

Formatted as “YYYY-MM-DD”.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:CreateConsolidatedBookings>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:pickupDate>?</cha:pickupDate>
      </cha:CreateConsolidatedBookings>
   </soapenv:Body>
</soapenv:Envelope>

FetchAddressByID

Addresses are stored in the database as records with a unique ID. To increase efficiency the platform is designed to store the AddressID of an address record rather than the entire address data against a consignment record. As a result of this design decision it is a requirement that the address data be retrievable if the AddressID is known. In some scenarios the complete dataset of a consignment record will need to be known or displayed. A consignment record (returned as a consignment object) contains a receiver and sender property, where the value of these properties is an AddressID.  By calling this function and passing the AddressID the complete address data becomes available.

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

AddressID

Int

M

10

AddressID object is returned object when calling the SaveAddress function

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:FetchAddressByID>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:addressID>?</cha:addressID>
      </cha:FetchAddressByID>
   </soapenv:Body>
</soapenv:Envelope>

FetchBookingsByAccountAndDate

It may be necessary to view all bookings requested for a specific date. This function takes a Session Key and a DateTime to filter all bookings that match. The function returns Booking Notification objects that includes summary booking details and the ConfirmationID.

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

pickupDate

string

M

10

Formatted as “YYYY-MM-DD”.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:FetchBookingsByAccountAndDate>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:pickupDate>?</cha:pickupDate>
      </cha:FetchBookingsByAccountAndDate>
   </soapenv:Body>
</soapenv:Envelope>
</soapenv:Envelope>

FetchConsignmentTracking

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

ConsignmentID

Long

M

20

This is the unique identification number applied to the consignment. Note** This number is different to the Consignment Note sequence.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:FetchConsignmentTracking>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:consignmentID>?</cha:consignmentID>
      </cha:FetchConsignmentTracking>
   </soapenv:Body>
</soapenv:Envelope>

FindLocation

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

countryCode

String

M

5

Use this string to specific the country. E.g “AU”

searchValue

DateTime

M

50

This value will search for suburbs or postcodes that contain the searchValue.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:FindLocation>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:countryCode>?</cha:countryCode>
         <!--Optional:-->
         <cha:searchValue>?</cha:searchValue>
      </cha:FindLocation>
   </soapenv:Body>
</soapenv:Envelope>

GenerateDailyManifest

This is the function that is used to generate the manifest. The function finds all released consignments applicable to the Session object and flags them for manifesting. The result is that the EDI Manifest Data process occurs and the system generates a printable pdf manifest.

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:GenerateDailyManifests>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
      </cha:GenerateDailyManifests>
   </soapenv:Body>
</soapenv:Envelope>

GenerateLabels

Each consignment record in the database is stored with a Connote value which is the prefix and sequence value prescribed by the carrier applicable to the consignment. The consignment is stored as a record with a unique ConsignmentID. This function is used to request a pdf byte string that represents the deconstructed label(s) for each consignment. The server side function creates the label format based on a prescribed label template. This function requires a Session object to be passed as the first parameter for security purposes. A label can be re-generated at any point in time provided the Session object is valid and the ConsignmentID is associated with the AccountID from the Session Object.

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

ConsignmentID

Long

M

20

This is the unique identification number applied to the consignment. Note** This number is different to the Consignment Note sequence.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:GenerateLabels>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:consignmentID>?</cha:consignmentID>
      </cha:GenerateLabels>
   </soapenv:Body>
</soapenv:Envelope>

GenerateManifest

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

ManifestId

Int

M

10

This is the unique identifier for the manifest object create when a single, batch or all consignments were manifested.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:GenerateManifest>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:manifestID>?</cha:manifestID>
      </cha:GenerateManifest>
   </soapenv:Body>
</soapenv:Envelope>

GetChargeQuote3

To retrieve a quote a list of parameters are passed for this function and a ServicePricing object is returned. This function uses the Locality and Postcode of the Sender and the Receiver coupled with a serviceList (returned from the function GetStandardServices) and the specific details such as items, weight and volume. The server side function matches the parameters against the AccountID’s rate card to determine the available services and the calculated cost.

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

shipperID

Int

M

10

This value represents your assigned account id and can be found as a property in your Session object.

effectiveDate

String

M

10

Formatted as “YYYY-MM-DD”.

senderLocation

String

M

10

Description of the suburb name, should be validated by using FindLocation to ensure correct spelling.

senderPostcode

String

M

4

Postcode matching the senderLocation. Should be validated by using the FindLocation method to ensure validity.

senderCountryCode

String

M

5

CountryCode matching the senderLocation. Should be validated by using the FindLocation method to ensure validity.

senderIsResidential

Bool

O

1

Flags for whether the address is residential. Used to pre-empt residential pick up fees.

receiverAddress1

String

O

30


receiverAddress2

String

O

30


receiverLocation

String

M

10

Description of the suburb name, should be validated by using FindLocation to ensure correct spelling.

receiverPstcode

String

M

4

Postcode matching the receiverLocation. Should be validated by using the FindLocation method to ensure validity.

receiverCountryCode

String

M

5

CountryCode matching the receiverLocation. Should be validated by using the FindLocation method to ensure validity.

receiverIsResidential

Bool

O

1

Flags for whether the address is residential. Used to pre-empt residential delivery fees.

Items

Short

M

5

Represents the total number of shipping items.

Weight

Float

M


Sum of shipping items weight in kilograms.

Volume

Float

M


Sum of shipping items cubic metres. M3

Time

Float

O


Estimated Travel Time. Recommended not to be used as inaccuracies in time calculation greatly vary quote results.

Distance

Float

O


Estimated Distance between sender and receiver locations. Recommended not to be used as inaccuracies in route taken greatly vary quote results.

serviceList

String

O


Concatenated string of active services for the current Session. Found by called GetStandardServices function.

containsDGs

String

M


Flags whether shipping items contain dangerous goods. Required for compliance and dangerous goods handling fee calculations.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:GetChargeQuote3>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:shipperID>?</cha:shipperID>
         <!--Optional:-->
         <cha:effectiveDate>?</cha:effectiveDate>
         <!--Optional:-->
         <cha:senderLocation>?</cha:senderLocation>
         <!--Optional:-->
         <cha:senderPostcode>?</cha:senderPostcode>
         <!--Optional:-->
         <cha:senderCountryCode>?</cha:senderCountryCode>
         <!--Optional:-->
         <cha:senderIsResidential>?</cha:senderIsResidential>
         <!--Optional:-->
         <cha:receiverAddress1>?</cha:receiverAddress1>
         <!--Optional:-->
         <cha:receiverAddress2>?</cha:receiverAddress2>
         <!--Optional:-->
         <cha:receiverLocation>?</cha:receiverLocation>
         <!--Optional:-->
         <cha:receiverPostcode>?</cha:receiverPostcode>
         <!--Optional:-->
         <cha:receiverCountryCode>?</cha:receiverCountryCode>
         <!--Optional:-->
         <cha:receiverIsResidential>?</cha:receiverIsResidential>
         <!--Optional:-->
         <cha:items>?</cha:items>
         <!--Optional:-->
         <cha:weight>?</cha:weight>
         <!--Optional:-->
         <cha:volume>?</cha:volume>
         <!--Optional:-->
         <cha:time>?</cha:time>
         <!--Optional:-->
         <cha:distance>?</cha:distance>
         <!--Optional:-->
         <cha:serviceList>?</cha:serviceList>
         <!--Optional:-->
         <cha:containsDGs>?</cha:containsDGs>
      </cha:GetChargeQuote3>
   </soapenv:Body>
</soapenv:Envelope>

GetChargeQuote5

To retrieve a quote a list of parameters are passed for this function and a ServicePricing object is returned. This function uses the Locality and Postcode of the Sender and the Receiver coupled with a serviceList (returned from the function GetStandardServices) and the specific details such as items, weight and volume. The server side function matches the parameters against the AccountID’s rate card to determine the available services and the calculated cost.

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

shipperID

Int

M

10

This value represents your assigned account id and can be found as a property in your Session object.

effectiveDate

String

M

10

Formatted as “YYYY-MM-DD”.

senderLocation

String

M

10

Description of the suburb name, should be validated by using FindLocation to ensure correct spelling.

senderPostcode

String

M

4

Postcode matching the senderLocation. Should be validated by using the FindLocation method to ensure validity.

senderCountryCode

String

M

5

CountryCode matching the senderLocation. Should be validated by using the FindLocation method to ensure validity.

senderIsResidential

Bool

O

1

Flags for whether the address is residential. Used to pre-empt residential pick up fees.

receiverAddress1

String

O

30


receiverAddress2

String

O

30


receiverLocation

String

M

10

Description of the suburb name, should be validated by using FindLocation to ensure correct spelling.

receiverPostcode

String

M

4

Postcode matching the receiverLocation. Should be validated by using the FindLocation method to ensure validity.

receiverCountryCode

String

M

5

CountryCode matching the receiverLocation. Should be validated by using the FindLocation method to ensure validity.

receiverIsResidential

Bool

O

1

Flags for whether the address is residential. Used to pre-empt residential delivery fees.

Items

Short

M

5

Represents the total number of shipping items.

Weight

Float

M


Sum of shipping items weight in kilograms.

Volume

Float

M


Sum of shipping items cubic metres. M3

Time

Float

O


Estimated Travel Time. Recommended not to be used as inaccuracies in time calculation greatly vary quote results.

Distance

Float

O


Estimated Distance between sender and receiver locations. Recommended not to be used as inaccuracies in route taken greatly vary quote results.

serviceList

String

O


Concatenated string of active services for the current Session. Found by called GetStandardServices function.

userID

Int

M


Current user ID. Can be found from the id property of the Session object.

itemsList

ConsignmentItem

M


This is an array of ConsignmentItem objects that are being quoted. Allows for greater clarity of quoting. E.g Shipping Item Dimensions.

containsDGs

String

M


Flags whether shipping items contain dangerous goods. Required for compliance and dangerous goods handling fee calculations.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:GetChargeQuote5>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:shipperID>?</cha:shipperID>
         <!--Optional:-->
         <cha:effectiveDate>?</cha:effectiveDate>
         <!--Optional:-->
         <cha:senderLocation>?</cha:senderLocation>
         <!--Optional:-->
         <cha:senderPostcode>?</cha:senderPostcode>
         <!--Optional:-->
         <cha:senderCountryCode>?</cha:senderCountryCode>
         <!--Optional:-->
         <cha:senderIsResidential>?</cha:senderIsResidential>
         <!--Optional:-->
         <cha:receiverAddress1>?</cha:receiverAddress1>
         <!--Optional:-->
         <cha:receiverAddress2>?</cha:receiverAddress2>
         <!--Optional:-->
         <cha:receiverLocation>?</cha:receiverLocation>
         <!--Optional:-->
         <cha:receiverPostcode>?</cha:receiverPostcode>
         <!--Optional:-->
         <cha:receiverCountryCode>?</cha:receiverCountryCode>
         <!--Optional:-->
         <cha:receiverIsResidential>?</cha:receiverIsResidential>
         <!--Optional:-->
         <cha:items>?</cha:items>
         <!--Optional:-->
         <cha:weight>?</cha:weight>
         <!--Optional:-->
         <cha:volume>?</cha:volume>
         <!--Optional:-->
         <cha:time>?</cha:time>
         <!--Optional:-->
         <cha:distance>?</cha:distance>
         <!--Optional:-->
         <cha:serviceList>?</cha:serviceList>
         <!--Optional:-->
         <cha:userID>?</cha:userID>
         <!--Optional:-->
         <cha:itemsList>
            <!--Zero or more repetitions:-->
            <cha:ConsignmentItem>
               <!--Optional:-->
               <cha:Barcode>?</cha:Barcode>
               <!--Optional:-->
               <cha:ConsignmentID>?</cha:ConsignmentID>
               <!--Optional:-->
               <cha:ConsignmentProduct>
                  <!--Optional:-->
                  <cha:AccountID>?</cha:AccountID>
                  <!--Optional:-->
                  <cha:Code>?</cha:Code>
                  <!--Optional:-->
                  <cha:DangerousGoods>
                     <!--Optional:-->
                     <cha:AggrigateQuantity>?</cha:AggrigateQuantity>
                     <!--Optional:-->
                     <cha:ConsignmentID>?</cha:ConsignmentID>
                     <!--Optional:-->
                     <cha:DangerousGoodsID>?</cha:DangerousGoodsID>
                     <!--Optional:-->
                     <cha:DgClass>?</cha:DgClass>
                     <!--Optional:-->
                     <cha:Exception>
                        <!--Optional:-->
                        <cha:Message>?</cha:Message>
                        <!--Optional:-->
                        <cha:ModuleName>?</cha:ModuleName>
                        <!--Optional:-->
                        <cha:ProcedureName>?</cha:ProcedureName>
                     </cha:Exception>
                     <!--Optional:-->
                     <cha:Group>?</cha:Group>
                     <!--Optional:-->
                     <cha:ID>?</cha:ID>
                     <!--Optional:-->
                     <cha:ItemNo>?</cha:ItemNo>
                     <!--Optional:-->
                     <cha:LiquidVolume>?</cha:LiquidVolume>
                     <!--Optional:-->
                     <cha:Liquidweight>?</cha:Liquidweight>
                     <!--Optional:-->
                     <cha:Name>?</cha:Name>
                     <!--Optional:-->
                     <cha:PSN>?</cha:PSN>
                     <!--Optional:-->
                     <cha:Quantity>?</cha:Quantity>
                     <!--Optional:-->
                     <cha:Recepticle>?</cha:Recepticle>
                     <!--Optional:-->
                     <cha:SubRisk>?</cha:SubRisk>
                     <!--Optional:-->
                     <cha:UnCode>?</cha:UnCode>
                     <!--Optional:-->
                     <cha:Units>?</cha:Units>
                     <!--Optional:-->
                     <cha:Volume>?</cha:Volume>
                     <!--Optional:-->
                     <cha:Weight>?</cha:Weight>
                  </cha:DangerousGoods>
                  <!--Optional:-->
                  <cha:DangerousGoodsID>?</cha:DangerousGoodsID>
                  <!--Optional:-->
                  <cha:Error>
                     <!--Optional:-->
                     <cha:Message>?</cha:Message>
                     <!--Optional:-->
                     <cha:ModuleName>?</cha:ModuleName>
                     <!--Optional:-->
                     <cha:ProcedureName>?</cha:ProcedureName>
                  </cha:Error>
                  <!--Optional:-->
                  <cha:Height>?</cha:Height>
                  <!--Optional:-->
                  <cha:IsActive>?</cha:IsActive>
                  <!--Optional:-->
                  <cha:Length>?</cha:Length>
                  <!--Optional:-->
                  <cha:Name>?</cha:Name>
                  <!--Optional:-->
                  <cha:ProductID>?</cha:ProductID>
                  <!--Optional:-->
                  <cha:Volume>?</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>?</cha:Weight>
                  <!--Optional:-->
                  <cha:Width>?</cha:Width>
               </cha:ConsignmentProduct>
               <!--Optional:-->
               <cha:Description>?</cha:Description>
               <!--Optional:-->
               <cha:ExchangeReturnable>?</cha:ExchangeReturnable>
               <!--Optional:-->
               <cha:Height>?</cha:Height>
               <!--Optional:-->
               <cha:ItemNo>?</cha:ItemNo>
               <!--Optional:-->
               <cha:ItemType>?</cha:ItemType>
               <!--Optional:-->
               <cha:Length>?</cha:Length>
               <!--Optional:-->
               <cha:ModifiedBy>?</cha:ModifiedBy>
               <!--Optional:-->
               <cha:NoItems>?</cha:NoItems>
               <!--Optional:-->
               <cha:ProductID>?</cha:ProductID>
               <!--Optional:-->
               <cha:Reference>?</cha:Reference>
               <!--Optional:-->
               <cha:Returnable>?</cha:Returnable>
               <!--Optional:-->
               <cha:Volume>?</cha:Volume>
               <!--Optional:-->
               <cha:Weight>?</cha:Weight>
               <!--Optional:-->
               <cha:Width>?</cha:Width>
            </cha:ConsignmentItem>
         </cha:itemsList>
         <!--Optional:-->
         <cha:containsDGs>?</cha:containsDGs>
      </cha:GetChargeQuote5>
   </soapenv:Body>
</soapenv:Envelope>

GetLocationsByPostcode

Element

Type

Optional / Mandatory

Length

Comments

postcode

String

M

4


countryCode

String

M

5

Use this string to specific the country. E.g “AU”

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:GetLocationsByPostcode>
         <!--Optional:-->
         <cha:postCode>?</cha:postCode>
         <!--Optional:-->
         <cha:countryCode>?</cha:countryCode>
      </cha:GetLocationsByPostcode>
   </soapenv:Body>
</soapenv:Envelope>

GetStandardServices

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:GetStandardServices>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
      </cha:GetStandardServices>
   </soapenv:Body>
</soapenv:Envelope>

Login

A majority of the functions listed in this document require a Session object be passed as the first parameter. This is a security principle that has been maintained across all functions that return customer sensitive data. Once a successful call has been made to the function then the Session object will contain a validated Session Key. This Key remains valid for 24 Hours and the DateTime of validity is stipulated in the Expires property.

Element

Type

Optional / Mandatory

Length

Comments

userName

String

M

30


password

String

M

30


Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:Login>
         <!--Optional:-->
         <cha:userName>?</cha:userName>
         <!--Optional:-->
         <cha:password>?</cha:password>
      </cha:Login>
   </soapenv:Body>
</soapenv:Envelope>

Logout

This functions exists to ensure that the implementation of Web Services can be controlled by the user.

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:Logout>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>64796</cha:UserID>
         </cha:session>
      </cha:Logout>
   </soapenv:Body>
</soapenv:Envelope>

ReleaseAllConsignments

This function is required to allow for the release of all consignments. This function is a prerequisite task that must be called prior to generating the daily manifest. It takes a Session object, a Boolean value for placing bookings automatically for all consignments and a booelan value for generating the manifest.

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

releaseDate

String

M


Formatted as “YYYY-MM-DD”.

generateBookingRequests

Bool

O


Creates a booking for all Consignments. Not recommended for use.

generateManifests

Bool

O


Creates ManifestID for all consignments. Not recommended. Use specific Release Consignment functions.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:ReleaseAllConsignments>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:releaseDate>?</cha:releaseDate>
         <!--Optional:-->
         <cha:generateBookingRequests>?</cha:generateBookingRequests>
         <!--Optional:-->
         <cha:generateManifests>?</cha:generateManifests>
      </cha:ReleaseAllConsignments>
   </soapenv:Body>
</soapenv:Envelope>

ReleaseSelectConsignments

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

consignIDs

Long[]

M


An Array of ConsignmentID’s to be manifested.

generateBookingRequests

Bool

O


Creates a booking for all Consignments in the consignID array. Not recommended for use.

generateManifests

Bool

O


Creates ManifestID for all consignments in consignID array.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:ReleaseSelectConsignments>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:consignIDs>
            <!--Zero or more repetitions:-->
            <arr:long>?</arr:long>
         </cha:consignIDs>
         <!--Optional:-->
         <cha:releaseDate>?</cha:releaseDate>
         <!--Optional:-->
         <cha:generateBookingRequests>?</cha:generateBookingRequests>
         <!--Optional:-->
         <cha:generateManifests>?</cha:generateManifests>
      </cha:ReleaseSelectConsignments>
   </soapenv:Body>
</soapenv:Envelope>

ReleaseSingleConsignment

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

consignIDs

Long

M


One ConsignmentID  to be manifested.

generateBookingRequests

Bool

O


Creates a booking for the consignment in consignID parameter. Not recommended for use.

generateManifests

Bool

O


Creates ManifestID for consignment in consignID parameter.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:ReleaseSingleConsignment>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:consignmentID>?</cha:consignmentID>
         <!--Optional:-->
         <cha:releaseDate>?</cha:releaseDate>
         <!--Optional:-->
         <cha:generateBookingRequest>?</cha:generateBookingRequest>
         <!--Optional:-->
         <cha:generateManifests>?</cha:generateManifests>
      </cha:ReleaseSingleConsignment>
   </soapenv:Body>
</soapenv:Envelope>

SaveAddress

A property required for creating a Consignment object is the Sender and Receiver AddressID. The platform has been designed in such a way that each address record is given a unique identifier and this identifier is stored against the consignment record. To maximise the efficiency of the platform, when a new consignment is to be created a request can be made to save a new address and if a record exists in the database that matches the unique combination of the address line, state, suburb and postcode then the existing identifier is returned. If there is no match a new record is created with the data parameters and the newly created identifier is returned.

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

address

Address

M


Fully constructed Address object.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:SaveAddress>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:address>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:AddressID>?</cha:AddressID>
            <!--Optional:-->
            <cha:AddressLocation>
               <!--Optional:-->
               <cha:LocationID>?</cha:LocationID>
               <!--Optional:-->
               <cha:Locality>?</cha:Locality>
               <!--Optional:-->
               <cha:State>?</cha:State>
               <!--Optional:-->
               <cha:Postcode>?</cha:Postcode>
               <!--Optional:-->
               <cha:CountryCode>?</cha:CountryCode>
               <!--Optional:-->
               <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
            </cha:AddressLocation>
            <!--Optional:-->
            <cha:ContactName>?</cha:ContactName>
            <!--Optional:-->
            <cha:Email>?</cha:Email>
            <!--Optional:-->
            <cha:Exception>
               <!--Optional:-->
               <cha:Message>?</cha:Message>
               <!--Optional:-->
               <cha:ModuleName>?</cha:ModuleName>
               <!--Optional:-->
               <cha:ProcedureName>?</cha:ProcedureName>
            </cha:Exception>
            <!--Optional:-->
            <cha:Fax>?</cha:Fax>
            <!--Optional:-->
            <cha:Line1>?</cha:Line1>
            <!--Optional:-->
            <cha:Line2>?</cha:Line2>
            <!--Optional:-->
            <cha:Line3>?</cha:Line3>
            <!--Optional:-->
            <cha:LocationDetails>
               <!--Optional:-->
               <cha:LocationID>?</cha:LocationID>
               <!--Optional:-->
               <cha:Locality>?</cha:Locality>
               <!--Optional:-->
               <cha:State>?</cha:State>
               <!--Optional:-->
               <cha:Postcode>?</cha:Postcode>
               <!--Optional:-->
               <cha:CountryCode>?</cha:CountryCode>
               <!--Optional:-->
               <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
            </cha:LocationDetails>
            <!--Optional:-->
            <cha:LocationID>?</cha:LocationID>
            <!--Optional:-->
            <cha:ModifiedBy>?</cha:ModifiedBy>
            <!--Optional:-->
            <cha:Name>?</cha:Name>
            <!--Optional:-->
            <cha:Phone>?</cha:Phone>
            <!--Optional:-->
            <cha:State>?</cha:State>
            <!--Optional:-->
            <cha:Suburb>?</cha:Suburb>
         </cha:address>
      </cha:SaveAddress>
   </soapenv:Body>
</soapenv:Envelope>

SaveAndBookConsignment

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

Consignment

Consignment

M


Fully constructed Consignment object.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:SaveAndBookConsignment>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:consignment>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:CloseAt>?</cha:CloseAt>
            <!--Optional:-->
            <cha:ConsignmentDate>?</cha:ConsignmentDate>
            <!--Optional:-->
            <cha:ConsignmentID>?</cha:ConsignmentID>
            <!--Optional:-->
            <cha:ConsignmentItems>
               <!--Zero or more repetitions:-->
               <cha:ConsignmentItem>
                  <!--Optional:-->
                  <cha:Barcode>?</cha:Barcode>
                  <!--Optional:-->
                  <cha:ConsignmentID>?</cha:ConsignmentID>
                  <!--Optional:-->
                  <cha:ConsignmentProduct>
                     <!--Optional:-->
                     <cha:AccountID>?</cha:AccountID>
                     <!--Optional:-->
                     <cha:Code>?</cha:Code>
                     <!--Optional:-->
                     <cha:DangerousGoods>
                        <!--Optional:-->
                        <cha:AggrigateQuantity>?</cha:AggrigateQuantity>
                        <!--Optional:-->
                        <cha:ConsignmentID>?</cha:ConsignmentID>
                        <!--Optional:-->
                        <cha:DangerousGoodsID>?</cha:DangerousGoodsID>
                        <!--Optional:-->
                        <cha:DgClass>?</cha:DgClass>
                        <!--Optional:-->
                        <cha:Exception>
                           <!--Optional:-->
                           <cha:Message>?</cha:Message>
                           <!--Optional:-->
                           <cha:ModuleName>?</cha:ModuleName>
                           <!--Optional:-->
                           <cha:ProcedureName>?</cha:ProcedureName>
                        </cha:Exception>
                        <!--Optional:-->
                        <cha:Group>?</cha:Group>
                        <!--Optional:-->
                        <cha:ID>?</cha:ID>
                        <!--Optional:-->
                        <cha:ItemNo>?</cha:ItemNo>
                        <!--Optional:-->
                        <cha:LiquidVolume>?</cha:LiquidVolume>
                        <!--Optional:-->
                        <cha:Liquidweight>?</cha:Liquidweight>
                        <!--Optional:-->
                        <cha:Name>?</cha:Name>
                        <!--Optional:-->
                        <cha:PSN>?</cha:PSN>
                        <!--Optional:-->
                        <cha:Quantity>?</cha:Quantity>
                        <!--Optional:-->
                        <cha:Recepticle>?</cha:Recepticle>
                        <!--Optional:-->
                        <cha:SubRisk>?</cha:SubRisk>
                        <!--Optional:-->
                        <cha:UnCode>?</cha:UnCode>
                        <!--Optional:-->
                        <cha:Units>?</cha:Units>
                        <!--Optional:-->
                        <cha:Volume>?</cha:Volume>
                        <!--Optional:-->
                        <cha:Weight>?</cha:Weight>
                     </cha:DangerousGoods>
                     <!--Optional:-->
                     <cha:DangerousGoodsID>?</cha:DangerousGoodsID>
                     <!--Optional:-->
                     <cha:Error>
                        <!--Optional:-->
                        <cha:Message>?</cha:Message>
                        <!--Optional:-->
                        <cha:ModuleName>?</cha:ModuleName>
                        <!--Optional:-->
                        <cha:ProcedureName>?</cha:ProcedureName>
                     </cha:Error>
                     <!--Optional:-->
                     <cha:Height>?</cha:Height>
                     <!--Optional:-->
                     <cha:IsActive>?</cha:IsActive>
                     <!--Optional:-->
                     <cha:Length>?</cha:Length>
                     <!--Optional:-->
                     <cha:Name>?</cha:Name>
                     <!--Optional:-->
                     <cha:ProductID>?</cha:ProductID>
                     <!--Optional:-->
                     <cha:Volume>?</cha:Volume>
                     <!--Optional:-->
                     <cha:Weight>?</cha:Weight>
                     <!--Optional:-->
                     <cha:Width>?</cha:Width>
                  </cha:ConsignmentProduct>
                  <!--Optional:-->
                  <cha:Description>?</cha:Description>
                  <!--Optional:-->
                  <cha:ExchangeReturnable>?</cha:ExchangeReturnable>
                  <!--Optional:-->
                  <cha:Height>?</cha:Height>
                  <!--Optional:-->
                  <cha:ItemNo>?</cha:ItemNo>
                  <!--Optional:-->
                  <cha:ItemType>?</cha:ItemType>
                  <!--Optional:-->
                  <cha:Length>?</cha:Length>
                  <!--Optional:-->
                  <cha:ModifiedBy>?</cha:ModifiedBy>
                  <!--Optional:-->
                  <cha:NoItems>?</cha:NoItems>
                  <!--Optional:-->
                  <cha:ProductID>?</cha:ProductID>
                  <!--Optional:-->
                  <cha:Reference>?</cha:Reference>
                  <!--Optional:-->
                  <cha:Returnable>?</cha:Returnable>
                  <!--Optional:-->
                  <cha:Volume>?</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>?</cha:Weight>
                  <!--Optional:-->
                  <cha:Width>?</cha:Width>
               </cha:ConsignmentItem>
            </cha:ConsignmentItems>
            <!--Optional:-->
            <cha:ConsignmentNote>?</cha:ConsignmentNote>
            <!--Optional:-->
            <cha:ConsignmentType>?</cha:ConsignmentType>
            <!--Optional:-->
            <cha:ConsolidatedSus>
               <!--Zero or more repetitions:-->
               <cha:ConsolidateConsignment>
                  <!--Optional:-->
                  <cha:Height>?</cha:Height>
                  <!--Optional:-->
                  <cha:ItemType>?</cha:ItemType>
                  <!--Optional:-->
                  <cha:Items>?</cha:Items>
                  <!--Optional:-->
                  <cha:Length>?</cha:Length>
                  <!--Optional:-->
                  <cha:Volume>?</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>?</cha:Weight>
                  <!--Optional:-->
                  <cha:Width>?</cha:Width>
               </cha:ConsolidateConsignment>
            </cha:ConsolidatedSus>
            <!--Optional:-->
            <cha:ContainingConsignment>?</cha:ContainingConsignment>
            <!--Optional:-->
            <cha:DeliveryInstructions>?</cha:DeliveryInstructions>
            <!--Optional:-->
            <cha:Description>?</cha:Description>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:DownloadID>?</cha:DownloadID>
            <!--Optional:-->
            <cha:Exception>
               <!--Optional:-->
               <cha:Message>?</cha:Message>
               <!--Optional:-->
               <cha:ModuleName>?</cha:ModuleName>
               <!--Optional:-->
               <cha:ProcedureName>?</cha:ProcedureName>
            </cha:Exception>
            <!--Optional:-->
            <cha:Ext>
               <!--Optional:-->
               <cha:ConsignmentID>?</cha:ConsignmentID>
               <!--Optional:-->
               <cha:CostCenter>?</cha:CostCenter>
               <!--Optional:-->
               <cha:ThirdPartyAccount>?</cha:ThirdPartyAccount>
               <!--Optional:-->
               <cha:UserField1>?</cha:UserField1>
               <!--Optional:-->
               <cha:UserField2>?</cha:UserField2>
               <!--Optional:-->
               <cha:UserField3>?</cha:UserField3>
               <!--Optional:-->
               <cha:UserField4>?</cha:UserField4>
               <!--Optional:-->
               <cha:UserField5>?</cha:UserField5>
            </cha:Ext>
            <!--Optional:-->
            <cha:ExtraInfo>?</cha:ExtraInfo>
            <!--Optional:-->
            <cha:Hours>?</cha:Hours>
            <!--Optional:-->
            <cha:ModifiedBy>?</cha:ModifiedBy>
            <!--Optional:-->
            <cha:NoItems>?</cha:NoItems>
            <!--Optional:-->
            <cha:OnForwarder>?</cha:OnForwarder>
            <!--Optional:-->
            <cha:PickupInstructions>?</cha:PickupInstructions>
            <!--Optional:-->
            <cha:ReadyAt>?</cha:ReadyAt>
            <!--Optional:-->
            <cha:Receiver>
               <!--Optional:-->
               <cha:AccountID>?</cha:AccountID>
               <!--Optional:-->
               <cha:AddressID>?</cha:AddressID>
               <!--Optional:-->
               <cha:AddressLocation>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:AddressLocation>
               <!--Optional:-->
               <cha:ContactName>?</cha:ContactName>
               <!--Optional:-->
               <cha:Email>?</cha:Email>
               <!--Optional:-->
               <cha:Exception>
                  <!--Optional:-->
                  <cha:Message>?</cha:Message>
                  <!--Optional:-->
                  <cha:ModuleName>?</cha:ModuleName>
                  <!--Optional:-->
                  <cha:ProcedureName>?</cha:ProcedureName>
               </cha:Exception>
               <!--Optional:-->
               <cha:Fax>?</cha:Fax>
               <!--Optional:-->
               <cha:Line1>?</cha:Line1>
               <!--Optional:-->
               <cha:Line2>?</cha:Line2>
               <!--Optional:-->
               <cha:Line3>?</cha:Line3>
               <!--Optional:-->
               <cha:LocationDetails>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:LocationDetails>
               <!--Optional:-->
               <cha:LocationID>?</cha:LocationID>
               <!--Optional:-->
               <cha:ModifiedBy>?</cha:ModifiedBy>
               <!--Optional:-->
               <cha:Name>?</cha:Name>
               <!--Optional:-->
               <cha:Phone>?</cha:Phone>
               <!--Optional:-->
               <cha:State>?</cha:State>
               <!--Optional:-->
               <cha:Suburb>?</cha:Suburb>
            </cha:Receiver>
            <!--Optional:-->
            <cha:Reference>?</cha:Reference>
            <!--Optional:-->
            <cha:References>
               <!--Zero or more repetitions:-->
               <cha:Reference>
                  <!--Optional:-->
                  <cha:ConsignmentReference>?</cha:ConsignmentReference>
                  <!--Optional:-->
                  <cha:RemoveReference>?</cha:RemoveReference>
               </cha:Reference>
            </cha:References>
            <!--Optional:-->
            <cha:Released>?</cha:Released>
            <!--Optional:-->
            <cha:Sender>
               <!--Optional:-->
               <cha:AccountID>?</cha:AccountID>
               <!--Optional:-->
               <cha:AddressID>?</cha:AddressID>
               <!--Optional:-->
               <cha:AddressLocation>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:AddressLocation>
               <!--Optional:-->
               <cha:ContactName>?</cha:ContactName>
               <!--Optional:-->
               <cha:Email>?</cha:Email>
               <!--Optional:-->
               <cha:Exception>
                  <!--Optional:-->
                  <cha:Message>?</cha:Message>
                  <!--Optional:-->
                  <cha:ModuleName>?</cha:ModuleName>
                  <!--Optional:-->
                  <cha:ProcedureName>?</cha:ProcedureName>
               </cha:Exception>
               <!--Optional:-->
               <cha:Fax>?</cha:Fax>
               <!--Optional:-->
               <cha:Line1>?</cha:Line1>
               <!--Optional:-->
               <cha:Line2>?</cha:Line2>
               <!--Optional:-->
               <cha:Line3>?</cha:Line3>
               <!--Optional:-->
               <cha:LocationDetails>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:LocationDetails>
               <!--Optional:-->
               <cha:LocationID>?</cha:LocationID>
               <!--Optional:-->
               <cha:ModifiedBy>?</cha:ModifiedBy>
               <!--Optional:-->
               <cha:Name>?</cha:Name>
               <!--Optional:-->
               <cha:Phone>?</cha:Phone>
               <!--Optional:-->
               <cha:State>?</cha:State>
               <!--Optional:-->
               <cha:Suburb>?</cha:Suburb>
            </cha:Sender>
            <!--Optional:-->
            <cha:Service>?</cha:Service>
            <!--Optional:-->
            <cha:SessionID>?</cha:SessionID>
            <!--Optional:-->
            <cha:SpecialInstructions>?</cha:SpecialInstructions>
            <!--Optional:-->
            <cha:Volume>?</cha:Volume>
            <!--Optional:-->
            <cha:Weight>?</cha:Weight>
         </cha:consignment>
      </cha:SaveAndBookConsignment>
   </soapenv:Body>
</soapenv:Envelope>

SaveBookAndManifestConsignment

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

Consignment

Consignment

M


Fully constructed Consignment object.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:SaveBookAndManifestConsignment>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:consignment>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:CloseAt>?</cha:CloseAt>
            <!--Optional:-->
            <cha:ConsignmentDate>?</cha:ConsignmentDate>
            <!--Optional:-->
            <cha:ConsignmentID>?</cha:ConsignmentID>
            <!--Optional:-->
            <cha:ConsignmentItems>
               <!--Zero or more repetitions:-->
               <cha:ConsignmentItem>
                  <!--Optional:-->
                  <cha:Barcode>?</cha:Barcode>
                  <!--Optional:-->
                  <cha:ConsignmentID>?</cha:ConsignmentID>
                  <!--Optional:-->
                  <cha:ConsignmentProduct>
                     <!--Optional:-->
                     <cha:AccountID>?</cha:AccountID>
                     <!--Optional:-->
                     <cha:Code>?</cha:Code>
                     <!--Optional:-->
                     <cha:DangerousGoods>
                        <!--Optional:-->
                        <cha:AggrigateQuantity>?</cha:AggrigateQuantity>
                        <!--Optional:-->
                        <cha:ConsignmentID>?</cha:ConsignmentID>
                        <!--Optional:-->
                        <cha:DangerousGoodsID>?</cha:DangerousGoodsID>
                        <!--Optional:-->
                        <cha:DgClass>?</cha:DgClass>
                        <!--Optional:-->
                        <cha:Exception>
                           <!--Optional:-->
                           <cha:Message>?</cha:Message>
                           <!--Optional:-->
                           <cha:ModuleName>?</cha:ModuleName>
                           <!--Optional:-->
                           <cha:ProcedureName>?</cha:ProcedureName>
                        </cha:Exception>
                        <!--Optional:-->
                        <cha:Group>?</cha:Group>
                        <!--Optional:-->
                        <cha:ID>?</cha:ID>
                        <!--Optional:-->
                        <cha:ItemNo>?</cha:ItemNo>
                        <!--Optional:-->
                        <cha:LiquidVolume>?</cha:LiquidVolume>
                        <!--Optional:-->
                        <cha:Liquidweight>?</cha:Liquidweight>
                        <!--Optional:-->
                        <cha:Name>?</cha:Name>
                        <!--Optional:-->
                        <cha:PSN>?</cha:PSN>
                        <!--Optional:-->
                        <cha:Quantity>?</cha:Quantity>
                        <!--Optional:-->
                        <cha:Recepticle>?</cha:Recepticle>
                        <!--Optional:-->
                        <cha:SubRisk>?</cha:SubRisk>
                        <!--Optional:-->
                        <cha:UnCode>?</cha:UnCode>
                        <!--Optional:-->
                        <cha:Units>?</cha:Units>
                        <!--Optional:-->
                        <cha:Volume>?</cha:Volume>
                        <!--Optional:-->
                        <cha:Weight>?</cha:Weight>
                     </cha:DangerousGoods>
                     <!--Optional:-->
                     <cha:DangerousGoodsID>?</cha:DangerousGoodsID>
                     <!--Optional:-->
                     <cha:Error>
                        <!--Optional:-->
                        <cha:Message>?</cha:Message>
                        <!--Optional:-->
                        <cha:ModuleName>?</cha:ModuleName>
                        <!--Optional:-->
                        <cha:ProcedureName>?</cha:ProcedureName>
                     </cha:Error>
                     <!--Optional:-->
                     <cha:Height>?</cha:Height>
                     <!--Optional:-->
                     <cha:IsActive>?</cha:IsActive>
                     <!--Optional:-->
                     <cha:Length>?</cha:Length>
                     <!--Optional:-->
                     <cha:Name>?</cha:Name>
                     <!--Optional:-->
                     <cha:ProductID>?</cha:ProductID>
                     <!--Optional:-->
                     <cha:Volume>?</cha:Volume>
                     <!--Optional:-->
                     <cha:Weight>?</cha:Weight>
                     <!--Optional:-->
                     <cha:Width>?</cha:Width>
                  </cha:ConsignmentProduct>
                  <!--Optional:-->
                  <cha:Description>?</cha:Description>
                  <!--Optional:-->
                  <cha:ExchangeReturnable>?</cha:ExchangeReturnable>
                  <!--Optional:-->
                  <cha:Height>?</cha:Height>
                  <!--Optional:-->
                  <cha:ItemNo>?</cha:ItemNo>
                  <!--Optional:-->
                  <cha:ItemType>?</cha:ItemType>
                  <!--Optional:-->
                  <cha:Length>?</cha:Length>
                  <!--Optional:-->
                  <cha:ModifiedBy>?</cha:ModifiedBy>
                  <!--Optional:-->
                  <cha:NoItems>?</cha:NoItems>
                  <!--Optional:-->
                  <cha:ProductID>?</cha:ProductID>
                  <!--Optional:-->
                  <cha:Reference>?</cha:Reference>
                  <!--Optional:-->
                  <cha:Returnable>?</cha:Returnable>
                  <!--Optional:-->
                  <cha:Volume>?</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>?</cha:Weight>
                  <!--Optional:-->
                  <cha:Width>?</cha:Width>
               </cha:ConsignmentItem>
            </cha:ConsignmentItems>
            <!--Optional:-->
            <cha:ConsignmentNote>?</cha:ConsignmentNote>
            <!--Optional:-->
            <cha:ConsignmentType>?</cha:ConsignmentType>
            <!--Optional:-->
            <cha:ConsolidatedSus>
               <!--Zero or more repetitions:-->
               <cha:ConsolidateConsignment>
                  <!--Optional:-->
                  <cha:Height>?</cha:Height>
                  <!--Optional:-->
                  <cha:ItemType>?</cha:ItemType>
                  <!--Optional:-->
                  <cha:Items>?</cha:Items>
                  <!--Optional:-->
                  <cha:Length>?</cha:Length>
                  <!--Optional:-->
                  <cha:Volume>?</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>?</cha:Weight>
                  <!--Optional:-->
                  <cha:Width>?</cha:Width>
               </cha:ConsolidateConsignment>
            </cha:ConsolidatedSus>
            <!--Optional:-->
            <cha:ContainingConsignment>?</cha:ContainingConsignment>
            <!--Optional:-->
            <cha:DeliveryInstructions>?</cha:DeliveryInstructions>
            <!--Optional:-->
            <cha:Description>?</cha:Description>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:DownloadID>?</cha:DownloadID>
            <!--Optional:-->
            <cha:Exception>
               <!--Optional:-->
               <cha:Message>?</cha:Message>
               <!--Optional:-->
               <cha:ModuleName>?</cha:ModuleName>
               <!--Optional:-->
               <cha:ProcedureName>?</cha:ProcedureName>
            </cha:Exception>
            <!--Optional:-->
            <cha:Ext>
               <!--Optional:-->
               <cha:ConsignmentID>?</cha:ConsignmentID>
               <!--Optional:-->
               <cha:CostCenter>?</cha:CostCenter>
               <!--Optional:-->
               <cha:ThirdPartyAccount>?</cha:ThirdPartyAccount>
               <!--Optional:-->
               <cha:UserField1>?</cha:UserField1>
               <!--Optional:-->
               <cha:UserField2>?</cha:UserField2>
               <!--Optional:-->
               <cha:UserField3>?</cha:UserField3>
               <!--Optional:-->
               <cha:UserField4>?</cha:UserField4>
               <!--Optional:-->
               <cha:UserField5>?</cha:UserField5>
            </cha:Ext>
            <!--Optional:-->
            <cha:ExtraInfo>?</cha:ExtraInfo>
            <!--Optional:-->
            <cha:Hours>?</cha:Hours>
            <!--Optional:-->
            <cha:ModifiedBy>?</cha:ModifiedBy>
            <!--Optional:-->
            <cha:NoItems>?</cha:NoItems>
            <!--Optional:-->
            <cha:OnForwarder>?</cha:OnForwarder>
            <!--Optional:-->
            <cha:PickupInstructions>?</cha:PickupInstructions>
            <!--Optional:-->
            <cha:ReadyAt>?</cha:ReadyAt>
            <!--Optional:-->
            <cha:Receiver>
               <!--Optional:-->
               <cha:AccountID>?</cha:AccountID>
               <!--Optional:-->
               <cha:AddressID>?</cha:AddressID>
               <!--Optional:-->
               <cha:AddressLocation>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:AddressLocation>
               <!--Optional:-->
               <cha:ContactName>?</cha:ContactName>
               <!--Optional:-->
               <cha:Email>?</cha:Email>
               <!--Optional:-->
               <cha:Exception>
                  <!--Optional:-->
                  <cha:Message>?</cha:Message>
                  <!--Optional:-->
                  <cha:ModuleName>?</cha:ModuleName>
                  <!--Optional:-->
                  <cha:ProcedureName>?</cha:ProcedureName>
               </cha:Exception>
               <!--Optional:-->
               <cha:Fax>?</cha:Fax>
               <!--Optional:-->
               <cha:Line1>?</cha:Line1>
               <!--Optional:-->
               <cha:Line2>?</cha:Line2>
               <!--Optional:-->
               <cha:Line3>?</cha:Line3>
               <!--Optional:-->
               <cha:LocationDetails>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:LocationDetails>
               <!--Optional:-->
               <cha:LocationID>?</cha:LocationID>
               <!--Optional:-->
               <cha:ModifiedBy>?</cha:ModifiedBy>
               <!--Optional:-->
               <cha:Name>?</cha:Name>
               <!--Optional:-->
               <cha:Phone>?</cha:Phone>
               <!--Optional:-->
               <cha:State>?</cha:State>
               <!--Optional:-->
               <cha:Suburb>?</cha:Suburb>
            </cha:Receiver>
            <!--Optional:-->
            <cha:Reference>?</cha:Reference>
            <!--Optional:-->
            <cha:References>
               <!--Zero or more repetitions:-->
               <cha:Reference>
                  <!--Optional:-->
                  <cha:ConsignmentReference>?</cha:ConsignmentReference>
                  <!--Optional:-->
                  <cha:RemoveReference>?</cha:RemoveReference>
               </cha:Reference>
            </cha:References>
            <!--Optional:-->
            <cha:Released>?</cha:Released>
            <!--Optional:-->
            <cha:Sender>
               <!--Optional:-->
               <cha:AccountID>?</cha:AccountID>
               <!--Optional:-->
               <cha:AddressID>?</cha:AddressID>
               <!--Optional:-->
               <cha:AddressLocation>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:AddressLocation>
               <!--Optional:-->
               <cha:ContactName>?</cha:ContactName>
               <!--Optional:-->
               <cha:Email>?</cha:Email>
               <!--Optional:-->
               <cha:Exception>
                  <!--Optional:-->
                  <cha:Message>?</cha:Message>
                  <!--Optional:-->
                  <cha:ModuleName>?</cha:ModuleName>
                  <!--Optional:-->
                  <cha:ProcedureName>?</cha:ProcedureName>
               </cha:Exception>
               <!--Optional:-->
               <cha:Fax>?</cha:Fax>
               <!--Optional:-->
               <cha:Line1>?</cha:Line1>
               <!--Optional:-->
               <cha:Line2>?</cha:Line2>
               <!--Optional:-->
               <cha:Line3>?</cha:Line3>
               <!--Optional:-->
               <cha:LocationDetails>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:LocationDetails>
               <!--Optional:-->
               <cha:LocationID>?</cha:LocationID>
               <!--Optional:-->
               <cha:ModifiedBy>?</cha:ModifiedBy>
               <!--Optional:-->
               <cha:Name>?</cha:Name>
               <!--Optional:-->
               <cha:Phone>?</cha:Phone>
               <!--Optional:-->
               <cha:State>?</cha:State>
               <!--Optional:-->
               <cha:Suburb>?</cha:Suburb>
            </cha:Sender>
            <!--Optional:-->
            <cha:Service>?</cha:Service>
            <!--Optional:-->
            <cha:SessionID>?</cha:SessionID>
            <!--Optional:-->
            <cha:SpecialInstructions>?</cha:SpecialInstructions>
            <!--Optional:-->
            <cha:Volume>?</cha:Volume>
            <!--Optional:-->
            <cha:Weight>?</cha:Weight>
         </cha:consignment>
      </cha:SaveBookAndManifestConsignment>
   </soapenv:Body>
</soapenv:Envelope>

SaveConsignment

Once a Consignment object has been created containing the required parameters, including a validated SenderID, ReceiverID and ConsignmentItem object, this function can be called. Taking Consignment Object and Session object as input this function will generate a consignment record and the unique ConsignmentID is returned.

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

Consignment

Consignment

M


Fully constructed Consignment object.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:SaveConsignment>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:consignment>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:CloseAt>?</cha:CloseAt>
            <!--Optional:-->
            <cha:ConsignmentDate>?</cha:ConsignmentDate>
            <!--Optional:-->
            <cha:ConsignmentID>?</cha:ConsignmentID>
            <!--Optional:-->
            <cha:ConsignmentItems>
               <!--Zero or more repetitions:-->
               <cha:ConsignmentItem>
                  <!--Optional:-->
                  <cha:Barcode>?</cha:Barcode>
                  <!--Optional:-->
                  <cha:ConsignmentID>?</cha:ConsignmentID>
                  <!--Optional:-->
                  <cha:ConsignmentProduct>
                     <!--Optional:-->
                     <cha:AccountID>?</cha:AccountID>
                     <!--Optional:-->
                     <cha:Code>?</cha:Code>
                     <!--Optional:-->
                     <cha:DangerousGoods>
                        <!--Optional:-->
                        <cha:AggrigateQuantity>?</cha:AggrigateQuantity>
                        <!--Optional:-->
                        <cha:ConsignmentID>?</cha:ConsignmentID>
                        <!--Optional:-->
                        <cha:DangerousGoodsID>?</cha:DangerousGoodsID>
                        <!--Optional:-->
                        <cha:DgClass>?</cha:DgClass>
                        <!--Optional:-->
                        <cha:Exception>
                           <!--Optional:-->
                           <cha:Message>?</cha:Message>
                           <!--Optional:-->
                           <cha:ModuleName>?</cha:ModuleName>
                           <!--Optional:-->
                           <cha:ProcedureName>?</cha:ProcedureName>
                        </cha:Exception>
                        <!--Optional:-->
                        <cha:Group>?</cha:Group>
                        <!--Optional:-->
                        <cha:ID>?</cha:ID>
                        <!--Optional:-->
                        <cha:ItemNo>?</cha:ItemNo>
                        <!--Optional:-->
                        <cha:LiquidVolume>?</cha:LiquidVolume>
                        <!--Optional:-->
                        <cha:Liquidweight>?</cha:Liquidweight>
                        <!--Optional:-->
                        <cha:Name>?</cha:Name>
                        <!--Optional:-->
                        <cha:PSN>?</cha:PSN>
                        <!--Optional:-->
                        <cha:Quantity>?</cha:Quantity>
                        <!--Optional:-->
                        <cha:Recepticle>?</cha:Recepticle>
                        <!--Optional:-->
                        <cha:SubRisk>?</cha:SubRisk>
                        <!--Optional:-->
                        <cha:UnCode>?</cha:UnCode>
                        <!--Optional:-->
                        <cha:Units>?</cha:Units>
                        <!--Optional:-->
                        <cha:Volume>?</cha:Volume>
                        <!--Optional:-->
                        <cha:Weight>?</cha:Weight>
                     </cha:DangerousGoods>
                     <!--Optional:-->
                     <cha:DangerousGoodsID>?</cha:DangerousGoodsID>
                     <!--Optional:-->
                     <cha:Error>
                        <!--Optional:-->
                        <cha:Message>?</cha:Message>
                        <!--Optional:-->
                        <cha:ModuleName>?</cha:ModuleName>
                        <!--Optional:-->
                        <cha:ProcedureName>?</cha:ProcedureName>
                     </cha:Error>
                     <!--Optional:-->
                     <cha:Height>?</cha:Height>
                     <!--Optional:-->
                     <cha:IsActive>?</cha:IsActive>
                     <!--Optional:-->
                     <cha:Length>?</cha:Length>
                     <!--Optional:-->
                     <cha:Name>?</cha:Name>
                     <!--Optional:-->
                     <cha:ProductID>?</cha:ProductID>
                     <!--Optional:-->
                     <cha:Volume>?</cha:Volume>
                     <!--Optional:-->
                     <cha:Weight>?</cha:Weight>
                     <!--Optional:-->
                     <cha:Width>?</cha:Width>
                  </cha:ConsignmentProduct>
                  <!--Optional:-->
                  <cha:Description>?</cha:Description>
                  <!--Optional:-->
                  <cha:ExchangeReturnable>?</cha:ExchangeReturnable>
                  <!--Optional:-->
                  <cha:Height>?</cha:Height>
                  <!--Optional:-->
                  <cha:ItemNo>?</cha:ItemNo>
                  <!--Optional:-->
                  <cha:ItemType>?</cha:ItemType>
                  <!--Optional:-->
                  <cha:Length>?</cha:Length>
                  <!--Optional:-->
                  <cha:ModifiedBy>?</cha:ModifiedBy>
                  <!--Optional:-->
                  <cha:NoItems>?</cha:NoItems>
                  <!--Optional:-->
                  <cha:ProductID>?</cha:ProductID>
                  <!--Optional:-->
                  <cha:Reference>?</cha:Reference>
                  <!--Optional:-->
                  <cha:Returnable>?</cha:Returnable>
                  <!--Optional:-->
                  <cha:Volume>?</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>?</cha:Weight>
                  <!--Optional:-->
                  <cha:Width>?</cha:Width>
               </cha:ConsignmentItem>
            </cha:ConsignmentItems>
            <!--Optional:-->
            <cha:ConsignmentNote>?</cha:ConsignmentNote>
            <!--Optional:-->
            <cha:ConsignmentType>?</cha:ConsignmentType>
            <!--Optional:-->
            <cha:ConsolidatedSus>
               <!--Zero or more repetitions:-->
               <cha:ConsolidateConsignment>
                  <!--Optional:-->
                  <cha:Height>?</cha:Height>
                  <!--Optional:-->
                  <cha:ItemType>?</cha:ItemType>
                  <!--Optional:-->
                  <cha:Items>?</cha:Items>
                  <!--Optional:-->
                  <cha:Length>?</cha:Length>
                  <!--Optional:-->
                  <cha:Volume>?</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>?</cha:Weight>
                  <!--Optional:-->
                  <cha:Width>?</cha:Width>
               </cha:ConsolidateConsignment>
            </cha:ConsolidatedSus>
            <!--Optional:-->
            <cha:ContainingConsignment>?</cha:ContainingConsignment>
            <!--Optional:-->
            <cha:DeliveryInstructions>?</cha:DeliveryInstructions>
            <!--Optional:-->
            <cha:Description>?</cha:Description>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:DownloadID>?</cha:DownloadID>
            <!--Optional:-->
            <cha:Exception>
               <!--Optional:-->
               <cha:Message>?</cha:Message>
               <!--Optional:-->
               <cha:ModuleName>?</cha:ModuleName>
               <!--Optional:-->
               <cha:ProcedureName>?</cha:ProcedureName>
            </cha:Exception>
            <!--Optional:-->
            <cha:Ext>
               <!--Optional:-->
               <cha:ConsignmentID>?</cha:ConsignmentID>
               <!--Optional:-->
               <cha:CostCenter>?</cha:CostCenter>
               <!--Optional:-->
               <cha:ThirdPartyAccount>?</cha:ThirdPartyAccount>
               <!--Optional:-->
               <cha:UserField1>?</cha:UserField1>
               <!--Optional:-->
               <cha:UserField2>?</cha:UserField2>
               <!--Optional:-->
               <cha:UserField3>?</cha:UserField3>
               <!--Optional:-->
               <cha:UserField4>?</cha:UserField4>
               <!--Optional:-->
               <cha:UserField5>?</cha:UserField5>
            </cha:Ext>
            <!--Optional:-->
            <cha:ExtraInfo>?</cha:ExtraInfo>
            <!--Optional:-->
            <cha:Hours>?</cha:Hours>
            <!--Optional:-->
            <cha:ModifiedBy>?</cha:ModifiedBy>
            <!--Optional:-->
            <cha:NoItems>?</cha:NoItems>
            <!--Optional:-->
            <cha:OnForwarder>?</cha:OnForwarder>
            <!--Optional:-->
            <cha:PickupInstructions>?</cha:PickupInstructions>
            <!--Optional:-->
            <cha:ReadyAt>?</cha:ReadyAt>
            <!--Optional:-->
            <cha:Receiver>
               <!--Optional:-->
               <cha:AccountID>?</cha:AccountID>
               <!--Optional:-->
               <cha:AddressID>?</cha:AddressID>
               <!--Optional:-->
               <cha:AddressLocation>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:AddressLocation>
               <!--Optional:-->
               <cha:ContactName>?</cha:ContactName>
               <!--Optional:-->
               <cha:Email>?</cha:Email>
               <!--Optional:-->
               <cha:Exception>
                  <!--Optional:-->
                  <cha:Message>?</cha:Message>
                  <!--Optional:-->
                  <cha:ModuleName>?</cha:ModuleName>
                  <!--Optional:-->
                  <cha:ProcedureName>?</cha:ProcedureName>
               </cha:Exception>
               <!--Optional:-->
               <cha:Fax>?</cha:Fax>
               <!--Optional:-->
               <cha:Line1>?</cha:Line1>
               <!--Optional:-->
               <cha:Line2>?</cha:Line2>
               <!--Optional:-->
               <cha:Line3>?</cha:Line3>
               <!--Optional:-->
               <cha:LocationDetails>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:LocationDetails>
               <!--Optional:-->
               <cha:LocationID>?</cha:LocationID>
               <!--Optional:-->
               <cha:ModifiedBy>?</cha:ModifiedBy>
               <!--Optional:-->
               <cha:Name>?</cha:Name>
               <!--Optional:-->
               <cha:Phone>?</cha:Phone>
               <!--Optional:-->
               <cha:State>?</cha:State>
               <!--Optional:-->
               <cha:Suburb>?</cha:Suburb>
            </cha:Receiver>
            <!--Optional:-->
            <cha:Reference>?</cha:Reference>
            <!--Optional:-->
            <cha:References>
               <!--Zero or more repetitions:-->
               <cha:Reference>
                  <!--Optional:-->
                  <cha:ConsignmentReference>?</cha:ConsignmentReference>
                  <!--Optional:-->
                  <cha:RemoveReference>?</cha:RemoveReference>
               </cha:Reference>
            </cha:References>
            <!--Optional:-->
            <cha:Released>?</cha:Released>
            <!--Optional:-->
            <cha:Sender>
               <!--Optional:-->
               <cha:AccountID>?</cha:AccountID>
               <!--Optional:-->
               <cha:AddressID>?</cha:AddressID>
               <!--Optional:-->
               <cha:AddressLocation>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:AddressLocation>
               <!--Optional:-->
               <cha:ContactName>?</cha:ContactName>
               <!--Optional:-->
               <cha:Email>?</cha:Email>
               <!--Optional:-->
               <cha:Exception>
                  <!--Optional:-->
                  <cha:Message>?</cha:Message>
                  <!--Optional:-->
                  <cha:ModuleName>?</cha:ModuleName>
                  <!--Optional:-->
                  <cha:ProcedureName>?</cha:ProcedureName>
               </cha:Exception>
               <!--Optional:-->
               <cha:Fax>?</cha:Fax>
               <!--Optional:-->
               <cha:Line1>?</cha:Line1>
               <!--Optional:-->
               <cha:Line2>?</cha:Line2>
               <!--Optional:-->
               <cha:Line3>?</cha:Line3>
               <!--Optional:-->
               <cha:LocationDetails>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:LocationDetails>
               <!--Optional:-->
               <cha:LocationID>?</cha:LocationID>
               <!--Optional:-->
               <cha:ModifiedBy>?</cha:ModifiedBy>
               <!--Optional:-->
               <cha:Name>?</cha:Name>
               <!--Optional:-->
               <cha:Phone>?</cha:Phone>
               <!--Optional:-->
               <cha:State>?</cha:State>
               <!--Optional:-->
               <cha:Suburb>?</cha:Suburb>
            </cha:Sender>
            <!--Optional:-->
            <cha:Service>?</cha:Service>
            <!--Optional:-->
            <cha:SessionID>?</cha:SessionID>
            <!--Optional:-->
            <cha:SpecialInstructions>?</cha:SpecialInstructions>
            <!--Optional:-->
            <cha:Volume>?</cha:Volume>
            <!--Optional:-->
            <cha:Weight>?</cha:Weight>
         </cha:consignment>
      </cha:SaveConsignment>
   </soapenv:Body>
</soapenv:Envelope>

SavePickupRequest

Element

Type

Optional / Mandatory

Length

Comments

ValidSession

Session

M


Session object created using the Login method or by hard-coding the properties of a session object (See Request an API Key)

pickupRequest

PickUpRequest

M


Fully constructed PickupRequest object.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:SavePickupRequest>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:pickupRequest>
            <!--Optional:-->
            <cha:ActualItems>?</cha:ActualItems>
            <!--Optional:-->
            <cha:ActualPalletSpaces>?</cha:ActualPalletSpaces>
            <!--Optional:-->
            <cha:ActualVolume>?</cha:ActualVolume>
            <!--Optional:-->
            <cha:ActualWeight>?</cha:ActualWeight>
            <!--Optional:-->
            <cha:Cancelled>?</cha:Cancelled>
            <!--Optional:-->
            <cha:CancelledBy>?</cha:CancelledBy>
            <!--Optional:-->
            <cha:CarrierID>?</cha:CarrierID>
            <!--Optional:-->
            <cha:CloseAt>?</cha:CloseAt>
            <!--Optional:-->
            <cha:ConfirmationId>?</cha:ConfirmationId>
            <!--Optional:-->
            <cha:DetailItems>
               <!--Zero or more repetitions:-->
               <cha:PickupRequestDetail>
                  <!--Optional:-->
                  <cha:ConsignmentID>?</cha:ConsignmentID>
                  <!--Optional:-->
                  <cha:ConsignmentNote>?</cha:ConsignmentNote>
                  <!--Optional:-->
                  <cha:Items>?</cha:Items>
                  <!--Optional:-->
                  <cha:PickupRequestID>?</cha:PickupRequestID>
                  <!--Optional:-->
                  <cha:Volume>?</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>?</cha:Weight>
               </cha:PickupRequestDetail>
            </cha:DetailItems>
            <!--Optional:-->
            <cha:DetailedSUs>
               <!--Zero or more repetitions:-->
               <cha:Sus>
                  <!--Optional:-->
                  <cha:Barcode>?</cha:Barcode>
                  <!--Optional:-->
                  <cha:Height>?</cha:Height>
                  <!--Optional:-->
                  <cha:ItemNo>?</cha:ItemNo>
                  <!--Optional:-->
                  <cha:ItemType>?</cha:ItemType>
                  <!--Optional:-->
                  <cha:Length>?</cha:Length>
                  <!--Optional:-->
                  <cha:ReceiverAddress>
                     <!--Optional:-->
                     <cha:AccountID>?</cha:AccountID>
                     <!--Optional:-->
                     <cha:AddressID>?</cha:AddressID>
                     <!--Optional:-->
                     <cha:AddressLocation>
                        <!--Optional:-->
                        <cha:LocationID>?</cha:LocationID>
                        <!--Optional:-->
                        <cha:Locality>?</cha:Locality>
                        <!--Optional:-->
                        <cha:State>?</cha:State>
                        <!--Optional:-->
                        <cha:Postcode>?</cha:Postcode>
                        <!--Optional:-->
                        <cha:CountryCode>?</cha:CountryCode>
                        <!--Optional:-->
                        <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
                     </cha:AddressLocation>
                     <!--Optional:-->
                     <cha:ContactName>?</cha:ContactName>
                     <!--Optional:-->
                     <cha:Email>?</cha:Email>
                     <!--Optional:-->
                     <cha:Exception>
                        <!--Optional:-->
                        <cha:Message>?</cha:Message>
                        <!--Optional:-->
                        <cha:ModuleName>?</cha:ModuleName>
                        <!--Optional:-->
                        <cha:ProcedureName>?</cha:ProcedureName>
                     </cha:Exception>
                     <!--Optional:-->
                     <cha:Fax>?</cha:Fax>
                     <!--Optional:-->
                     <cha:Line1>?</cha:Line1>
                     <!--Optional:-->
                     <cha:Line2>?</cha:Line2>
                     <!--Optional:-->
                     <cha:Line3>?</cha:Line3>
                     <!--Optional:-->
                     <cha:LocationDetails>
                        <!--Optional:-->
                        <cha:LocationID>?</cha:LocationID>
                        <!--Optional:-->
                        <cha:Locality>?</cha:Locality>
                        <!--Optional:-->
                        <cha:State>?</cha:State>
                        <!--Optional:-->
                        <cha:Postcode>?</cha:Postcode>
                        <!--Optional:-->
                        <cha:CountryCode>?</cha:CountryCode>
                        <!--Optional:-->
                        <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
                     </cha:LocationDetails>
                     <!--Optional:-->
                     <cha:LocationID>?</cha:LocationID>
                     <!--Optional:-->
                     <cha:ModifiedBy>?</cha:ModifiedBy>
                     <!--Optional:-->
                     <cha:Name>?</cha:Name>
                     <!--Optional:-->
                     <cha:Phone>?</cha:Phone>
                     <!--Optional:-->
                     <cha:State>?</cha:State>
                     <!--Optional:-->
                     <cha:Suburb>?</cha:Suburb>
                  </cha:ReceiverAddress>
                  <!--Optional:-->
                  <cha:Reference>?</cha:Reference>
                  <!--Optional:-->
                  <cha:Volume>?</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>?</cha:Weight>
                  <!--Optional:-->
                  <cha:Width>?</cha:Width>
               </cha:Sus>
            </cha:DetailedSUs>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:EdiFormat>?</cha:EdiFormat>
            <!--Optional:-->
            <cha:EstimatedItems>?</cha:EstimatedItems>
            <!--Optional:-->
            <cha:EstimatedPalletSpaces>?</cha:EstimatedPalletSpaces>
            <!--Optional:-->
            <cha:EstimatedVolume>?</cha:EstimatedVolume>
            <!--Optional:-->
            <cha:EstimatedWeight>?</cha:EstimatedWeight>
            <!--Optional:-->
            <cha:Exception>
               <!--Optional:-->
               <cha:Message>?</cha:Message>
               <!--Optional:-->
               <cha:ModuleName>?</cha:ModuleName>
               <!--Optional:-->
               <cha:ProcedureName>?</cha:ProcedureName>
            </cha:Exception>
            <!--Optional:-->
            <cha:FileName>?</cha:FileName>
            <!--Optional:-->
            <cha:Instructions>?</cha:Instructions>
            <!--Optional:-->
            <cha:PickupDate>?</cha:PickupDate>
            <!--Optional:-->
            <cha:PickupRequestID>?</cha:PickupRequestID>
            <!--Optional:-->
            <cha:ReadyAt>?</cha:ReadyAt>
            <!--Optional:-->
            <cha:Reference>?</cha:Reference>
            <!--Optional:-->
            <cha:Response>?</cha:Response>
            <!--Optional:-->
            <cha:SalesForceException>?</cha:SalesForceException>
            <!--Optional:-->
            <cha:SalesForceId>?</cha:SalesForceId>
            <!--Optional:-->
            <cha:Sender>
               <!--Optional:-->
               <cha:AccountID>?</cha:AccountID>
               <!--Optional:-->
               <cha:AddressID>?</cha:AddressID>
               <!--Optional:-->
               <cha:AddressLocation>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:AddressLocation>
               <!--Optional:-->
               <cha:ContactName>?</cha:ContactName>
               <!--Optional:-->
               <cha:Email>?</cha:Email>
               <!--Optional:-->
               <cha:Exception>
                  <!--Optional:-->
                  <cha:Message>?</cha:Message>
                  <!--Optional:-->
                  <cha:ModuleName>?</cha:ModuleName>
                  <!--Optional:-->
                  <cha:ProcedureName>?</cha:ProcedureName>
               </cha:Exception>
               <!--Optional:-->
               <cha:Fax>?</cha:Fax>
               <!--Optional:-->
               <cha:Line1>?</cha:Line1>
               <!--Optional:-->
               <cha:Line2>?</cha:Line2>
               <!--Optional:-->
               <cha:Line3>?</cha:Line3>
               <!--Optional:-->
               <cha:LocationDetails>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:LocationDetails>
               <!--Optional:-->
               <cha:LocationID>?</cha:LocationID>
               <!--Optional:-->
               <cha:ModifiedBy>?</cha:ModifiedBy>
               <!--Optional:-->
               <cha:Name>?</cha:Name>
               <!--Optional:-->
               <cha:Phone>?</cha:Phone>
               <!--Optional:-->
               <cha:State>?</cha:State>
               <!--Optional:-->
               <cha:Suburb>?</cha:Suburb>
            </cha:Sender>
            <!--Optional:-->
            <cha:SenderID>?</cha:SenderID>
            <!--Optional:-->
            <cha:ShipperID>?</cha:ShipperID>
            <!--Optional:-->
            <cha:SummaryItems>
               <!--Zero or more repetitions:-->
               <cha:PickupRequestSummary>
                  <!--Optional:-->
                  <cha:CarrierID>?</cha:CarrierID>
                  <!--Optional:-->
                  <cha:CarrierServiceCode>?</cha:CarrierServiceCode>
                  <!--Optional:-->
                  <cha:CartonCount>?</cha:CartonCount>
                  <!--Optional:-->
                  <cha:CartonWeight>?</cha:CartonWeight>
                  <!--Optional:-->
                  <cha:OtherCount>?</cha:OtherCount>
                  <!--Optional:-->
                  <cha:OtherWeight>?</cha:OtherWeight>
                  <!--Optional:-->
                  <cha:PalletCount>?</cha:PalletCount>
                  <!--Optional:-->
                  <cha:PalletWeight>?</cha:PalletWeight>
                  <!--Optional:-->
                  <cha:PickupRequestID>?</cha:PickupRequestID>
                  <!--Optional:-->
                  <cha:PickupRequestSummaryID>?</cha:PickupRequestSummaryID>
                  <!--Optional:-->
                  <cha:SalesForceException>?</cha:SalesForceException>
                  <!--Optional:-->
                  <cha:SalesForceId>?</cha:SalesForceId>
                  <!--Optional:-->
                  <cha:ServiceCode>?</cha:ServiceCode>
                  <!--Optional:-->
                  <cha:SuType>?</cha:SuType>
                  <!--Optional:-->
                  <cha:TotalItems>?</cha:TotalItems>
                  <!--Optional:-->
                  <cha:TotalWeight>?</cha:TotalWeight>
               </cha:PickupRequestSummary>
            </cha:SummaryItems>
            <!--Optional:-->
            <cha:TransferMethod>?</cha:TransferMethod>
            <!--Optional:-->
            <cha:TransferSettingsID>?</cha:TransferSettingsID>
            <!--Optional:-->
            <cha:Transferred>?</cha:Transferred>
            <!--Optional:-->
            <cha:TransmitErrorMessage>?</cha:TransmitErrorMessage>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:pickupRequest>
      </cha:SavePickupRequest>
   </soapenv:Body>
</soapenv:Envelope>

ValidateLocation

A property of the Address object is the LocationID. This LocationID can be found by passing the State, Locality and Postcode of a location. If the combination of these properties exists, the matched LocationID is returned.

Element

Type

Optional / Mandatory

Length

Comments

Location

Location

M


Fully constructed Location object.

Example Body

Web Service Call Body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:ValidateLocation>
         <!--Optional:-->
         <cha:location>
            <!--Optional:-->
            <cha:LocationID>?</cha:LocationID>
            <!--Optional:-->
            <cha:Locality>?</cha:Locality>
            <!--Optional:-->
            <cha:State>?</cha:State>
            <!--Optional:-->
            <cha:Postcode>?</cha:Postcode>
            <!--Optional:-->
            <cha:CountryCode>?</cha:CountryCode>
            <!--Optional:-->
            <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
         </cha:location>
      </cha:ValidateLocation>
   </soapenv:Body>
</soapenv:Envelope>


Filter by label

There are no items with the selected labels at this time.



  • No labels