Versions Compared

Key

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


GetChargeQuote4 and GetChargeQuote5 returns
Notewarning
titleNot Required
Warning

GetQuote5 returns the exact same information as GetQuote.  
These Calls require significantly more information and is generally only required for the most complex implementations of OneFlo catering for very unique quoting requirements

Info

In this instance I am making a call to GetChargeQuote This example includes significant Complexities, We only recommend undertaking the process of utilizing this functionality only under the requirement of calculating rates for delivery of complex dangerous goods

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


*Learn how to chain this call in Creating Chained Requests

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

...

...

titleNot Required

...

Body:

Code Block
languagexml
themeRDark
firstline1
titleWeb Service Call
linenumberstrue
<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>0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
      <cha:GetChargeQuote4>
   
  <!-- 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:session>
            <cha:AccountID>115860</cha:AccountID>
            <!--Mandatory:-->
            <cha:DistributorID>101605</cha:DistributorID>
            <!--Mandatory:-->
            <cha:GetChargeQuote4>:Expires>2018-08-14T09:27:17.78</cha:Expires>
            <!--Mandatory:-->
  Session  Credentials Available By following the "Login Web Service Call" --> <cha:Key>D1F83B85-4EEE-4AD1-BC53-99E57836C246</cha:Key>
               <cha:session><!--Mandatory:-->
            <cha:AccountID>115860<UserID>64796</cha:AccountID>UserID>
            <!--Mandatory:-->
         </cha:session>
 
         <cha:DistributorID>101605<shipperID>115860</cha:DistributorID>
  shipperID>
         <!--Mandatory:-->
            <cha:Expires>2018-08-14T09:27:17.78<effectiveDate>15/08/2018</cha:Expires>
 effectiveDate>
          <!--Mandatory:-->
            <cha:Key>D1F83B85-4EEE-4AD1-BC53-99E57836C246</cha:Key>
  senderLocation>Nunawading</cha:senderLocation>
         <!--Mandatory:-->
            <cha:UserID>64796<senderPostcode>3131</cha:UserID>senderPostcode>
            <!--Mandatory:-->
         <<cha:senderCountryCode>AU</cha:session>senderCountryCode>
         <!--Mandatory:-->
         <cha:shipperID>115860<senderIsResidential>0</cha:shipperID>senderIsResidential>
          <!--Mandatory:-->Flags for whether the address is residential. Used to pre-empt residential pick  <cha:effectiveDate>15/08/2018</cha:effectiveDate>up fees.-->
         <!--Mandatory:!-->
           <cha:senderLocation>Nunawading</cha:senderLocation>  1 = Yes
     <!--Mandatory:-->        0  <cha:senderPostcode>3131</cha:senderPostcode>= No
         <!--Mandatory:-->
         <cha:senderCountryCode>AU<receiverAddress1>18 Sycamore Grove</cha:senderCountryCode>receiverAddress1>
         <!--Mandatory:-->
         <cha:senderIsResidential>0<receiverAddress2></cha:senderIsResidential>
         <!--Optional:Flags for whether the address is residential. Used to pre-empt residential pick up fees.receiverAddress2>
         <!--Mandatory:-->
         <cha:receiverAddress1>18 Sycamore Grove<receiverLocation>Narooma</cha:receiverAddress1>receiverLocation>
         <!--Mandatory:-->
         <cha:receiverAddress2><receiverPostcode>2546</cha:receiverAddress2>receiverPostcode>
         <!--Mandatory:-->
         <cha:receiverLocation>MOUNT EVELYN<receiverCountryCode>AU</cha:receiverLocation>receiverCountryCode>
         <!--Mandatory:-->
         <cha:receiverPostcode>3796<receiverIsResidential>0</cha:receiverPostcode>receiverIsResidential>
           <!--Mandatory:-->--Mandatory:Flags for whether the address is residential. Used to pre-empt residential pick up fees.-->
         <!--
           <cha:receiverCountryCode>AU</cha:receiverCountryCode>  1 = Yes
     <!--Mandatory:-->        0  <cha:receiverIsResidential>0</cha:receiverIsResidential>= No
         <!--Mandatory:-->
         <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. 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>0</cha:serviceList> Optional: Only use if you wish to filter different  <cha:serviceList>0</cha:serviceList>services -->
         <!--Optional:-->
         <cha:userID>64796</cha:userID>
         <!--Mandatory:-->

         <cha:itemsList>
            <!--Zero or more repetitions:-->

            <cha:ConsignmentItem>
               <!--Optional:-->
               <cha:Barcode>1</cha:Barcode>
               <!--Optional:-->
               <cha:ConsignmentID>666666</cha:ConsignmentID>
               <!--Optional:-->

               <cha:ConsignmentProduct>
                  <!--Optional:-->
                  <cha:AccountID>115860</cha:AccountID>
                  <!--Optional:-->
                  <cha:Code>1</cha:Code>
                  <!--Optional:-->

                  <cha:DangerousGoods>
                     <!--Optional:-->
                     <cha:AggrigateQuantity>1</cha:AggrigateQuantity>
                     <!--Optional:-->
                     <cha:ConsignmentID>1</cha:ConsignmentID>
                     <!--Optional:-->
                     <cha:DangerousGoodsID>1</cha:DangerousGoodsID>
                     <!--Optional:-->
                     <cha:DgClass>1</cha:DgClass>
                     <!--Optional:-->

                     <cha:Exception>
                        <!--Optional:-->
                        <cha:Message>Na</cha:Message>
                        <!--Optional:-->
                        <cha:ModuleName>Peter</cha:ModuleName>
                        <!--Optional:-->
                        <cha:ProcedureName>Test</cha:ProcedureName>
                     </cha:Exception>
                     <!--Optional:-->

                     <cha:Group>1</cha:Group>
                     <!--Optional:-->
                     <cha:ID>1</cha:ID>
                     <!--Optional:-->
                     <cha:ItemNo>1</cha:ItemNo>
                     <!--Optional:-->
                     <cha:LiquidVolume>1</cha:LiquidVolume>
                     <!--Optional:-->
                     <cha:Liquidweight>1</cha:Liquidweight>
                     <!--Optional:-->
                     <cha:Name>1</cha:Name>
                     <!--Optional:-->
                     <cha:PSN>1</cha:PSN>
                     <!--Optional:-->
                     <cha:Quantity>1</cha:Quantity>
                     <!--Optional:-->
                     <cha:Recepticle>1</cha:Recepticle>
                     <!--Optional:-->
                     <cha:SubRisk>1</cha:SubRisk>
                     <!--Optional:-->
                     <cha:UnCode>1</cha:UnCode>
                     <!--Optional:-->
                     <cha:Units>1</cha:Units>
                     <!--Optional:-->
                     <cha:Volume>1</cha:Volume>
                     <!--Optional:-->
                     <cha:Weight>1</cha:Weight>
                  </cha:DangerousGoods>

                     <!--Optional:-->
                  <cha:DangerousGoodsID>1</cha:DangerousGoodsID>
                  <!--Mandatory:-->

                  <cha:Error>
                     <!--Optional:-->
                     <cha:Message>1</cha:Message>
                     <!--Optional:-->
                     <cha:ModuleName>1</cha:ModuleName>
                     <!--Optional:-->
                     <cha:ProcedureName>1</cha:ProcedureName>
                  </cha:Error>

                  <!--Optional:-->
                  <cha:Height>1</cha:Height>
                  <!--Optional:-->
                  <cha:IsActive>1</cha:IsActive>
                  <!--Optional:-->
                  <cha:Length>1</cha:Length>
                  <!--Optional:-->
                  <cha:Name>1</cha:Name>
                  <!--Optional:-->
                  <cha:ProductID>1</cha:ProductID>
                  <!--Optional:-->
                  <cha:Volume>1</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>1</cha:Weight>
                  <!--Optional:-->
                  <cha:Width>1</cha:Width>
               </cha:ConsignmentProduct>
               <!--Optional:-->

               <cha:Description>Enter Description</cha:Description>
               <!--Optional:-->
               <cha:ExchangeReturnable>1</cha:ExchangeReturnable>
               <!--Optional:-->
               <cha:Height>1</cha:Height>
               <!--Optional:-->
               <cha:ItemNo>1</cha:ItemNo>
               <!--Optional:-->
               <cha:ItemType>1</cha:ItemType>
               <!--Optional:-->
               <cha:Length>1</cha:Length>
               <!--Optional:-->
               <cha:ModifiedBy>1</cha:ModifiedBy>
               <!--Optional:-->
               <cha:NoItems>1</cha:NoItems>
               <!--Optional:-->
               <cha:ProductID>1</cha:ProductID>
               <!--Optional:-->
               <cha:Reference>1</cha:Reference>
               <!--Optional:-->
               <cha:Returnable>1</cha:Returnable>
               <!--Optional:-->
               <cha:Volume>1</cha:Volume>
               <!--Optional:-->
               <cha:Weight>1</cha:Weight>
               <!--Optional:-->
               <cha:Width>1</cha:Width>
            </cha:ConsignmentItem>

         </cha:itemsList>
         <!--Optional:-->

         <cha:containsDGs>0</cha:containsDGs>             
         <!--Mandatory:Flags whether shipping items contain dangerous  </cha:itemsList>
         <!--Optional:--goods. Required for compliance and dangerous goods handling fee calculations.-->
          <cha:containsDGs>0</cha:containsDGs>             
         <!--Mandatory:<!--
			 1 = Yes
			 0 = No 
		 -->
      </cha:GetChargeQuote4>
   </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>
      <GetChargeQuote4Response 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>101956</CarrierID>
               <CarrierName>TOLL IPEC PTY LTD</CarrierName>
               <CarrierService>L</CarrierService>
               <ETA>16/08/2018</ETA>
               <FeesCharge>237.1800</FeesCharge>
               <FreightCharge>1652.8100</FreightCharge>
               <ID>0</ID>
               <NetCharge>1889.9900</NetCharge>
               <RateID>9607039</RateID>
               <ServiceName>IPEC Local</ServiceName>
               <ShipperService>IPECL</ShipperService>
               <TaxCharge>189.0000</TaxCharge>
               <TotalCharge>2078.9900</TotalCharge>
               <WebDescription>Toll Ipec Local</WebDescription>
               <ZoneFrom>MEL1</ZoneFrom>
               <ZoneTo>IVIC</ZoneTo>
            </ServicePricing>
            <ServicePricing>
               <CalculatedSUType>UnDefined</CalculatedSUType>
               <CarrierID>101956</CarrierID>
               <CarrierName>TOLL IPEC PTY LTD</CarrierName>
               <CarrierService>X</CarrierService>
               <ETA>16/08/2018</ETA>
               <FeesCharge>261.2700</FeesCharge>
               <FreightCharge>1820.6700</FreightCharge>
               <ID>0</ID>
               <NetCharge>2081.9400</NetCharge>
               <RateID>9607176</RateID>
               <ServiceName>IPEC Road Express</ServiceName>
               <ShipperService>IPECX</ShipperService>
               <TaxCharge>208.2000</TaxCharge>
               <TotalCharge>2290.1400</TotalCharge>
               <WebDescription>Toll Ipec Road Express</WebDescription>
               <ZoneFrom>MEL1</ZoneFrom>
               <ZoneTo>IVIC</ZoneTo>
            </ServicePricing>
            <ServicePricing>
               <CalculatedSUType>UnDefined</CalculatedSUType>
               <CarrierID>102958</CarrierID>
               <CarrierName>Hi-Trans Express Pty Ltd</CarrierName>
               <CarrierService>G</CarrierService>
               <ETA/>
               <FeesCharge>327.8300</FeesCharge>
               <FreightCharge>1927.2900</FreightCharge>
               <ID>0</ID>
               <NetCharge>2255.1200</NetCharge>
               <RateID>10702459</RateID>
               <ServiceName>Hi Trans General Service</ServiceName>
               <ShipperService>HITRANG</ShipperService>
               <TaxCharge>225.5100</TaxCharge>
               <TotalCharge>2480.6300</TotalCharge>
               <WebDescription>Hi-Trans General</WebDescription>
               <ZoneFrom>MEL</ZoneFrom>
               <ZoneTo>VC1I</ZoneTo>
            </ServicePricing>
            <ServicePricing>
               <CalculatedSUType>UnDefined</CalculatedSUType>
               <CarrierID>102958</CarrierID>
               <CarrierName>Hi-Trans Express Pty Ltd</CarrierName>
               <CarrierService>X</CarrierService>
               <ETA/>
               <FeesCharge>392.8600</FeesCharge>
               <FreightCharge>2309.5900</FreightCharge>
               <ID>0</ID>
               <NetCharge>2702.4500</NetCharge>
               <RateID>10702460</RateID>
               <ServiceName>Hi-Trans Express Service</ServiceName>
               <ShipperService>HITRANX</ShipperService>
               <TaxCharge>270.2500</TaxCharge>
               <TotalCharge>2972.7000</TotalCharge>
               <WebDescription>Hi Trans Express</WebDescription>
               <ZoneFrom>MEL</ZoneFrom>
               <ZoneTo>VC1I</ZoneTo>
            </ServicePricing>
            <ServicePricing>
               <CalculatedSUType>UnDefined</CalculatedSUType>
               <CarrierID>101956</CarrierID>
               <CarrierName>TOLL IPEC PTY LTD</CarrierName>
               <CarrierService>H</CarrierService>
               <ETA>16/08/2018</ETA>
               <FeesCharge>766.2200</FeesCharge>
               <FreightCharge>4895.9800</FreightCharge>
               <ID>0</ID>
               <NetCharge>5662.2000</NetCharge>
               <RateID>9606992</RateID>
               <ServiceName>IPEC Priority</ServiceName>
               <ShipperService>IPECH</ShipperService>
               <TaxCharge>566.2200</TaxCharge>
               <TotalCharge>6228.4200</TotalCharge>
               <WebDescription>Toll Ipec Priority</WebDescription>
               <ZoneFrom>MEL1</ZoneFrom>
               <ZoneTo>IVIC</ZoneTo>
            </ServicePricing>
         </GetChargeQuote4Result>
      </GetChargeQuote4Response>
   </s:Body>
</s:Envelope>



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

...