Page Comparison

...

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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.

...

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>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:consignmentID>connoteReference>?</cha:consignmentID>
</cha:CancelConsignment>
<connoteReference>
         <!--Optional:-->
         <cha:consignmentDate>?</cha:consignmentDate>
      </cha:ConsignmentTrackingSearch>
   </soapenv:Body>
</soapenv:Envelope>

...

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>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            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:consignmentID>:connoteReference>?</cha:connoteReference>
         <!--Optional:-->
         <cha:consignmentDate>?</cha:consignmentDate>
         <!--Optional:-->
         <cha:distributorId>?</cha:distributorId>
         <!--Optional:-->
         <cha:accountId>?</cha:consignmentID>accountId>
      </cha:CancelConsignment>ConsignmentTrackingSearchByDistributorByAccount>
   </soapenv:Body>
</soapenv:Envelope>

...

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
<soapenv   <soapenv:Header/>
   <soapenv:Body>
      <cha:CancelConsignment>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:consignmentID>pickupDate>?</cha:consignmentID>pickupDate>
      </cha:CancelConsignment>CreateConsolidatedBookings>
   </soapenv:Body>
</soapenv:Envelope>

...

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>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:consignmentID>addressID>?</cha:consignmentID>addressID>
</cha:CancelConsignment>
      </cha:FetchAddressByID>
   </soapenv:Body>
</soapenv:Envelope>

FetchBookingsByAccountAndDate

...

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>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:consignmentID>         <cha:pickupDate>?</cha:consignmentID>pickupDate>
      </cha:CancelConsignment>FetchBookingsByAccountAndDate>
   </soapenv:Body>
</soapenv:Envelope>
</soapenv:Envelope>

FetchConsignmentTracking

...

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>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:CancelConsignment>FetchConsignmentTracking>
   </soapenv:Body>
</soapenv:Envelope>

...

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>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:consignmentID>searchValue>?</cha:consignmentID>searchValue>
      </cha:CancelConsignment>FindLocation>
   </soapenv:Body>
</soapenv:Envelope>

...

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>GenerateDailyManifests>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
<cha:            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
<!--Optional:-->
<cha:consignmentID>?
      </cha:consignmentID>
</cha:CancelConsignment>GenerateDailyManifests>
   </soapenv:Body>
</soapenv:Envelope>

GenerateLabels

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.

...

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>GenerateLabels>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
<cha            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:consignmentID>?</cha:consignmentID>
      </cha:CancelConsignment>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.

...

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>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:consignmentID>manifestID>?</cha:consignmentID>manifestID>
      </cha:CancelConsignment>GenerateManifest>
   </soapenv:Body>
</soapenv:Envelope>

...

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>GetChargeQuote3>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
<!--Optional:-->
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:consignmentID>shipperID>?</cha:consignmentID>
shipperID>
         <!--Optional:-->
         <cha:effectiveDate>?</cha:CancelConsignment>
</soapenv:Body>
</soapenv:Envelope>

GetChargeQuote5

...

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>

...

Element

...

Type

...

Optional / Mandatory

...

Length

...

Comments

...

userName

...

String

...

M

...

30

...

password

...

String

...

M

...

30

Example Body

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>

Logout

...

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>

ReleaseAllConsignments

...

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>

SaveAddress

...

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>

SaveConsignment

...

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>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

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>

Element	Type	Optional / Mandatory	Length	Comments
userName	String	M	30
password	String	M	30

Example Body

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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

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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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

Element	Type	Optional / Mandatory	Length	Comments
Location	Location	M		Fully constructed Location object.

...

Code Block

language	xml
theme	RDark
firstline	1
title	Web Service Call Body
linenumbers	true
collapse	true

<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>ValidateLocation>
         <!--Optional:-->
<cha:session>>
         <cha:location>
            <!--Optional:-->
            <cha:AccountID>LocationID>?</cha:AccountID>LocationID>
            <!--Optional:-->
            <cha:DistributorID>Locality>?</cha:DistributorID>Locality>
            <!--Optional:-->
            <cha:Expires>State>?</cha:Expires>State>
            <!--Optional:-->
            <cha:Key>Postcode>?</cha:Key>Postcode>
            <!--Optional:-->
            <cha:UserID>CountryCode>?</cha:UserID>
</cha:session>CountryCode>
            <!--Optional:-->
            <cha:consignmentID>SuburbStatePostcode>?</cha:consignmentID>SuburbStatePostcode>
         </cha:location>
      </cha:CancelConsignment>ValidateLocation>
   </soapenv:Body>
</soapenv:Envelope>

Object Property Definition (Table Format)

...

Versions Compared

Old Version 13

New Version 14

Key

ConsignmentTrackSearch

FetchBookingsByAccountAndDate

FetchConsignmentTracking

GenerateLabels

GenerateManifest

GetChargeQuote5

GetLocationsByPostcode

GetStandardServices

Logout

ReleaseAllConsignments

ReleaseSelectConsignments

ReleaseSingleConsignment

SaveAddress

SaveAndBookConsignment

SaveBookAndManifestConsignment

SaveConsignment

SavePickupRequest

GetChargeQuote5

GetLocationsByPostcode

GetStandardServices

Logout

ReleaseAllConsignments

ReleaseSelectConsignments

ReleaseSingleConsignment

SaveAddress

SaveAndBookConsignment

SaveBookAndManifestConsignment

SaveConsignment

SavePickupRequest

ValidateLocation

Object Property Definition (Table Format)