Web Service Call - GetChargeQuote3

Purpose

This Web Service Call allows a third party application to retrieve a list of services and their associated estimated charges based on the parameters provided such as:

Sending Location
Receiving Location
Dimensions of the freight to be quoted

This service only provides estimated charges (which may include fees) but the final invoice amount will be determined once the freight has successfully traveled.

GetChargeQuote3 returns the exact same information as GetQuote. This example includes a Country Code and consignment relevant information that may help provide a more accurate quote.

*Learn how to chain this call in Creating Chained Requests

Warning

All calls that return quoting information require a valid Australian address. Please consult the Australia Post Website to confirm your suburb information if returning a failed response.

http://auspost.com.au/postcode/

In this instance I am making a call to GetChargeQuote in my uat environment through postman, Things I need to perform this call:

My Session Credentials form my previous Login Call
1. Note Session Credentials will expire If
  1. You Have generated a new "Key"
  2. You Have Passed the Expiry Date of the Session
  3. The User has been Deleted/made inactive
Your package/quote information

Endpoint: https://bau-uat-ws.azurewebsites.net/Data/ChainIT/DataService.svc

This is not the production endpoint. The production endpoint will be provided once all requests have been validated to work correctly.

Headers:

Key: Content-Type Value: text/xml
Key: SoapAction Value: http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices/IChainITService/GetChargeQuote 3

Body:

Web Service Call

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>      
      <GetChargeQuote3>

  <!-- Session Credentials Available By following the "Login Web Service Call" 
							https://flipgroup.atlassian.net/wiki/spaces/FLIP/pages/703102977/2a+Example+Web+Service+Call+Login-->      
         <session>
            <AccountID>{{AccountID}}</AccountID>
            <DistributorID>{{DistributorID}}</DistributorID>
            <Expires>{{Expires}}</Expires>
            <Key>{{Key}}</Key>
            <UserID>{{UserID}}</UserID>
         </session>
         
         <shipperID>{{AccountID}}</shipperID>
         <effectiveDate>01/08/2019</effectiveDate>
         <senderLocation>SCORESBY</senderLocation>
         <senderPostcode>3179</senderPostcode>
         <senderCountryCode>AU</senderCountryCode>
         <senderIsResidential>0</senderIsResidential>
         <!--Mandatory:Flags for whether the address is residential. Used to pre-empt residential pick up fees.-->
         <!--
             1 = Yes
             0 = No
         -->
         <receiverAddress1>123 Test</receiverAddress1>
         <receiverAddress2></receiverAddress2>
         <receiverLocation>HALLAM</receiverLocation>
         <receiverPostcode>3803</receiverPostcode>
         <receiverCountryCode>AU</receiverCountryCode>
         <receiverIsResidential>0</receiverIsResidential>
         <!--Mandatory:Flags for whether the address is residential. Used to pre-empt residential pick up fees.-->
         <!--
             1 = Yes
             0 = No
         -->
         <items>1</items>
         <weight>4</weight>
         <volume>.001</volume>
         <!--Mandatory:-->
         <time>0</time>
         <!--Optional:Estimated Travel Time. Recommended not to be used as inaccuracies in time calculation greatly vary quote results.-->
         <!--
             1 = Yes
             0 = No
         -->
         <distance>0</distance>
          <!--Optional: Estimated Distance between sender and receiver locations. Recommended not to be used as inaccuracies in route taken greatly vary quote results. -->
         <!--
             1 = Yes
             0 = No
         -->
         <!-- <serviceList></serviceList> Optional: Only use if you wish to filter different services -->
         <!--Optional: Concatenated string of active services for the current Session. Found by called GetStandardServices function. -->
         <containsDGs>0</containsDGs>
          <!--Mandatory:Flags whether shipping items contain dangerous goods. Required for compliance and dangerous goods handling fee calculations.-->
         <!--
             1 = Yes
             0 = No
         -->
      </GetChargeQuote3>
   </soapenv:Body>
</soapenv:Envelope>

Successful Web Service Call Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <GetChargeQuote3Response xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
            <GetChargeQuote3Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <ServicePricing>
                    <CalculatedSUType>UnDefined</CalculatedSUType>
                    <CarrierID>106008</CarrierID>
                    <CarrierName>StarTrack Express</CarrierName>
                    <CarrierService>EXP</CarrierService>
                    <ETA>02/08/2019</ETA>
                    <FeesCharge>1.1300</FeesCharge>
                    <FreightCharge>8.0400</FreightCharge>
                    <ID>0</ID>
                    <NetCharge>9.1700</NetCharge>
                    <RateID>15433078</RateID>
                    <ServiceName>StarTrack Road Express</ServiceName>
                    <ShipperService>STEEXP</ShipperService>
                    <TaxCharge>0.9100</TaxCharge>
                    <TotalCharge>10.0800</TotalCharge>
                    <WebDescription>Startrack Road Express</WebDescription>
                    <ZoneFrom>MEL</ZoneFrom>
                    <ZoneTo>MEL</ZoneTo>
                </ServicePricing>
                <ServicePricing>
                    <CalculatedSUType>UnDefined</CalculatedSUType>
                    <CarrierID>106008</CarrierID>
                    <CarrierName>StarTrack Express</CarrierName>
                    <CarrierService>FPP</CarrierService>
                    <ETA>02/08/2019</ETA>
                    <FeesCharge>2.4500</FeesCharge>
                    <FreightCharge>16.0700</FreightCharge>
                    <ID>0</ID>
                    <NetCharge>18.5200</NetCharge>
                    <RateID>15433553</RateID>
                    <ServiceName>Star Track Fixed Price Premium</ServiceName>
                    <ShipperService>STEFPP</ShipperService>
                    <TaxCharge>1.8600</TaxCharge>
                    <TotalCharge>20.3800</TotalCharge>
                    <WebDescription>Star Track Fixed Price Premium</WebDescription>
                    <ZoneFrom>MEL</ZoneFrom>
                    <ZoneTo>MEL</ZoneTo>
                </ServicePricing>
            </GetChargeQuote3Result>
        </GetChargeQuote3Response>
    </s:Body>
</s:Envelope>

Related articles

Filter by label