Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

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.

Info

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

  1. 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
  2. Your package/quote information

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

Headers: 

Note
titleNot Required

Header declaration is not required for SoapUI. *SoapUI does this automatically

Body:

...

languagexml
themeRDark
firstline1
titleWeb Service Call
linenumberstrue

...

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:

  1. Sending Location
  2. Receiving Location
  3. 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. 


Note

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
titleWarning

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/


Info

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

  1. 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
  2. Your package/quote information

Endpoint: https://uat-thirdpartywcf.flipgroup.com.au/DataService.svc

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

Headers: 

Body:

Code Block
languagexml
themeRDark
firstline1
titleWeb Service Call
linenumberstrue
<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>

  <!--Mandatory:-->
            <cha:DistributorID>101605</cha:DistributorID>
            <!--Mandatory:-- 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-->      
      <cha:Expires>2018-08-14T09:27:17.78</cha:Expires>   <session>
            <!--Mandatory:--><AccountID>{{AccountID}}</AccountID>
            <cha:Key>D1F83B85-4EEE-4AD1-BC53-99E57836C246</cha:Key>
            <!--Mandatory:-->
            <cha:UserID>64796</cha:UserID>
			<!--Mandatory:-->
         </cha:session>


         <cha:shipperID>115860</cha:shipperID>
         <!--Mandatory:-->
         <cha:effectiveDate>15/08/2018</cha:effectiveDate>
         <!--Mandatory:-->
         <cha:senderLocation>Nunawading</cha:senderLocation>
         <!--Mandatory:-->
         <cha:senderPostcode>3131</cha:senderPostcode>
         <!--Mandatory:-->
         <cha:senderCountryCode>AU</cha:senderCountryCode>
         <!--Mandatory:-->
         <cha:senderIsResidential>0</cha:senderIsResidential>
         <!--Mandatory:Flags for whether the address is residential. Used to pre-empt residential pick up fees.-->
         <!--
			 1 = Yes
			 0 = No 
		 -->
         <cha:receiverAddress1>18 Sycamore Grove</cha:receiverAddress1>
         <!--Mandatory:-->
         <cha:receiverAddress2></cha:receiverAddress2>
         <!--Optional:-->
         <cha:receiverLocation>Narooma</cha:receiverLocation>
         <!--Mandatory:-->
         <cha:receiverPostcode>2546</cha:receiverPostcode>
         <!--Mandatory:-->
         <cha:receiverCountryCode>AU</cha:receiverCountryCode>
         <!--Mandatory:-->
         <cha:receiverIsResidential>0</cha:receiverIsResidential>
         <!--Mandatory:Flags for whether the address is residential. Used to pre-empt residential pick up fees.-->
         <!--
			 1 = Yes
			 0 = No 
		 -->
         <cha:items>4</cha:items>
         <!--Mandatory:-->
         <cha:weight>18</cha:weight>
         <!--Mandatory:-->
         <cha:volume>20</cha:volume>
         <!--Mandatory:-->
         <cha:time>0</cha:time>
         <!--Optional:Estimated Travel Time. Recommended not to be used as inaccuracies in time calculation greatly vary quote results.-->
         <!--
			 1 = Yes
			 0 = No 
		 -->
         <cha:distance>0</cha: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 
		 -->
         <cha:serviceList></cha:serviceList>
		 <!--Optional: Concatenated string of active services for the current Session. Found by called GetStandardServices function. -->
         <cha:containsDGs>0</cha:containsDGs>
          <!--Mandatory:Flags whether shipping items contain dangerous goods. Required for compliance and dangerous goods handling fee calculations.-->
         <!--
			 1 = Yes
			 0 = No 
		 -->
      </cha:GetChargeQuote3>
   </soapenv:Body>
</soapenv:Envelope>
Code Block
languagexml
themeRDark
firstline1
titleSuccessful Web Service Call Response
linenumberstrue
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body><DistributorID>{{DistributorID}}</DistributorID>
            <Expires>{{Expires}}</Expires>
           <GetChargeQuote3Response xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices"> <Key>{{Key}}</Key>
           <GetChargeQuote3Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <UserID>{{UserID}}</UserID>
         </session>
   <ServicePricing>      
         <CalculatedSUType>UnDefined</CalculatedSUType><shipperID>{{AccountID}}</shipperID>
         <effectiveDate>01/08/2019</effectiveDate>
     <CarrierID>101956</CarrierID>    <senderLocation>SCORESBY</senderLocation>
         <senderPostcode>3179</senderPostcode>
 <CarrierName>TOLL IPEC PTY LTD</CarrierName>      <senderCountryCode>AU</senderCountryCode>
         <CarrierService>L<<senderIsResidential>0</CarrierService>senderIsResidential>
         <!--Mandatory:Flags for whether the address  <ETA>16/08/2018</ETA>
      is residential. Used to pre-empt residential pick up fees.-->
        <FeesCharge>237.1800</FeesCharge>
 <!--
             1 <FreightCharge>1652.8100</FreightCharge>= Yes
             0 <ID>0</ID>= No
         -->
    <NetCharge>1889.9900</NetCharge>     <receiverAddress1>123 Test</receiverAddress1>
         <RateID>9607039<<receiverAddress2></RateID>receiverAddress2>
            <receiverLocation>HALLAM</receiverLocation>
  <ServiceName>IPEC Local</ServiceName>      <receiverPostcode>3803</receiverPostcode>
         <ShipperService>IPECL<<receiverCountryCode>AU</ShipperService>receiverCountryCode>
         <receiverIsResidential>0</receiverIsResidential>
     <TaxCharge>189.0000</TaxCharge>    <!--Mandatory:Flags for whether the address is residential. Used to pre-empt residential delivery <TotalCharge>2078.9900</TotalCharge>fees.-->
         <!--
      <WebDescription>Toll Ipec Local</WebDescription>     1 = Yes
        <ZoneFrom>MEL1</ZoneFrom>     0 = No
        <ZoneTo>IVIC</ZoneTo> -->
         <items>1</items>
 </ServicePricing>        <weight>4</weight>
    <ServicePricing>     <volume>.001</volume>
          <CalculatedSUType>UnDefined</CalculatedSUType><!--Mandatory:-->
         <time>0</time>
      <CarrierID>101956</CarrierID>   <!--Optional:Estimated Travel Time. Recommended not to be used as inaccuracies in time calculation <CarrierName>TOLLgreatly IPECvary PTY LTD</CarrierName>quote results.-->
         <!--
     <CarrierService>X</CarrierService>        1 = Yes
     <ETA>16/08/2018</ETA>        0 = No
     <FeesCharge>261.2700</FeesCharge>    -->
         <distance>0</distance>
 <FreightCharge>1820.6700</FreightCharge>         <!--Optional: Estimated Distance between sender and receiver <ID>0</ID>locations. Recommended not to be used as inaccuracies in route taken greatly vary quote   <NetCharge>2081.9400</NetCharge>
results. -->
         <!--
    <RateID>9607176</RateID>         1 = Yes
    <ServiceName>IPEC Road Express</ServiceName>       0 =  No
     <ShipperService>IPECX</ShipperService>      -->
         <TaxCharge>208.2000</TaxCharge>
        <!-- <serviceList></serviceList> Optional: Only use if you wish to filter different services -->
      <TotalCharge>2290.1400</TotalCharge>   <!--Optional: Concatenated string of active services for the current Session. Found by called <WebDescription>TollGetStandardServices Ipec Road Express</WebDescription>function. -->
         <containsDGs>0</containsDGs>
      <ZoneFrom>MEL1</ZoneFrom>    <!--Mandatory:Flags whether shipping items contain dangerous goods. Required for compliance and dangerous <ZoneTo>IVIC</ZoneTo>goods handling fee calculations.-->
         </ServicePricing>!--
             <ServicePricing>1 = Yes
             <CalculatedSUType>UnDefined</CalculatedSUType>0 = No
         -->
   <CarrierID>102958</CarrierID>   </GetChargeQuote3>
   </soapenv:Body>
</soapenv:Envelope>
     

<CarrierName>Hi-Trans Express Pty Ltd</CarrierName> 



Code Block
languagexml
themeRDark
firstline1
titleSuccessful Web Service Call Response
linenumberstrue
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
          <CarrierService>G</CarrierService>
               <ETA/<GetChargeQuote3Response xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
               <FeesCharge>327.8300</FeesCharge><GetChargeQuote3Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
               <FreightCharge>1927.2900</FreightCharge>
          <ServicePricing>
     <ID>0</ID>                <NetCharge>2255.1200</NetCharge><CalculatedSUType>UnDefined</CalculatedSUType>
                 <RateID>10702459</RateID>   <CarrierID>106008</CarrierID>
            <ServiceName>Hi Trans General Service</ServiceName>     <CarrierName>StarTrack Express</CarrierName>
         <ShipperService>HITRANG</ShipperService>           <CarrierService>EXP</CarrierService>
    <TaxCharge>225.5100</TaxCharge>                <TotalCharge>2480.6300</TotalCharge><ETA>02/08/2019</ETA>
                 <WebDescription>Hi-Trans General</WebDescription>  <FeesCharge>1.1300</FeesCharge>
             <ZoneFrom>MEL</ZoneFrom>       <FreightCharge>8.0400</FreightCharge>
        <ZoneTo>VC1I</ZoneTo>            <ID>0</ID>
</ServicePricing>             <ServicePricing>       <NetCharge>9.1700</NetCharge>
        <CalculatedSUType>UnDefined</CalculatedSUType>            <RateID>15433078</RateID>
   <CarrierID>102958</CarrierID>                <CarrierName>Hi-Trans Express<ServiceName>StarTrack PtyRoad Ltd<Express</CarrierName>ServiceName>
               <CarrierService>X</CarrierService>     <ShipperService>STEEXP</ShipperService>
          <ETA/>           <TaxCharge>0.9100</TaxCharge>
    <FeesCharge>392.8600</FeesCharge>                <FreightCharge>2309<TotalCharge>10.5900<0800</FreightCharge>TotalCharge>
               <ID>0</ID>     <WebDescription>Startrack Road Express</WebDescription>
        <NetCharge>2702.4500</NetCharge>             <ZoneFrom>MEL</ZoneFrom>
  <RateID>10702460</RateID>                <ServiceName>Hi-Trans Express Service<<ZoneTo>MEL</ServiceName>ZoneTo>
                <ShipperService>HITRANX<</ShipperService>ServicePricing>
               <TaxCharge>270.2500</TaxCharge> <ServicePricing>
              <TotalCharge>2972.7000</TotalCharge>      <CalculatedSUType>UnDefined</CalculatedSUType>
         <WebDescription>Hi Trans Express</WebDescription>         <CarrierID>106008</CarrierID>
      <ZoneFrom>MEL</ZoneFrom>              <CarrierName>StarTrack  <ZoneTo>VC1I<Express</ZoneTo>CarrierName>
            </ServicePricing>        <CarrierService>FPP</CarrierService>
    <ServicePricing>                <CalculatedSUType>UnDefined</CalculatedSUType><ETA>02/08/2019</ETA>
               <CarrierID>101956</CarrierID>     <FeesCharge>2.4500</FeesCharge>
          <CarrierName>TOLL IPEC PTY LTD</CarrierName>          <FreightCharge>16.0700</FreightCharge>
     <CarrierService>H</CarrierService>                <ETA>16/08/2018</ETA><ID>0</ID>
               <FeesCharge>766.2200</FeesCharge>     <NetCharge>18.5200</NetCharge>
          <FreightCharge>4895.9800</FreightCharge>          <RateID>15433553</RateID>
     <ID>0</ID>               <ServiceName>Star <NetCharge>5662.2000</NetCharge>Track Fixed Price Premium</ServiceName>
            <RateID>9606992</RateID>        <ShipperService>STEFPP</ShipperService>
       <ServiceName>IPEC Priority</ServiceName>            <TaxCharge>1.8600</TaxCharge>
   <ShipperService>IPECH</ShipperService>                 <TaxCharge>566<TotalCharge>20.2200<3800</TaxCharge>TotalCharge>
               <TotalCharge>6228.4200</TotalCharge>     <WebDescription>Star Track Fixed Price Premium</WebDescription>
      <WebDescription>Toll  Ipec Priority</WebDescription>           <ZoneFrom>MEL</ZoneFrom>
    <ZoneFrom>MEL1</ZoneFrom>                <ZoneTo>IVIC<<ZoneTo>MEL</ZoneTo>
                </ServicePricing>
            </GetChargeQuote3Result>
        </GetChargeQuote3Response>
    </s:Body>
</s:Envelope>

...


Related articles

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@20f86d
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "kb-how-to-article" and type = "page" and space = "FLIP"
labelskb-how-to-article

...