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:
|
Endpoint: https://bau-uat-ws.azurewebsites.net/Data/ChainIT/DataService.svc
Headers:
- Key: Content-Type Value: text/xml
- Key: SoapAction Value: http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices/IChainITService/GetChargeQuote3
Note | ||
---|---|---|
| ||
Header declaration is not required for SoapUI. *SoapUI does this automatically |
Body:
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
<soapenv:Header/>
<soapenv:Body>
<cha:GetChargeQuote3>
<!-- 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:Expires>2018-08-14T09:27:17.78</cha:Expires>
<!--Mandatory:-->
<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> |
...
language | xml |
---|---|
theme | RDark |
firstline | 1 |
title | Successful Web Service Call Response |
linenumbers | true |
collapse | true |
...
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.
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. |
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. |
Info |
---|
In this instance I am making a call to GetChargeQuote in my uat environment through postman, Things I need to perform this call:
|
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:
- Key: Content-Type Value: text/xml
- Key: SoapAction Value: http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices/IChainITService/GetChargeQuote3
Body:
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<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> <GetChargeQuote3Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <DistributorID>{{DistributorID}}</DistributorID> <Expires>{{Expires}}</Expires> <ServicePricing> <Key>{{Key}}</Key> <CalculatedSUType>UnDefined</CalculatedSUType><UserID>{{UserID}}</UserID> </session> <CarrierID>101956</CarrierID> <CarrierName>TOLL IPEC PTY LTD</CarrierName><shipperID>{{AccountID}}</shipperID> <effectiveDate>01/08/2019</effectiveDate> <CarrierService>L<<senderLocation>SCORESBY</CarrierService> senderLocation> <senderPostcode>3179</senderPostcode> <ETA>16/08/2018</ETA> <senderCountryCode>AU</senderCountryCode> <FeesCharge>237.1800</FeesCharge><senderIsResidential>0</senderIsResidential> <!--Mandatory:Flags for whether the address is <FreightCharge>1652residential.8100</FreightCharge> Used to pre-empt residential pick up fees.--> <ID>0</ID> <!-- <NetCharge>1889.9900</NetCharge>1 = Yes <RateID>9607039</RateID>0 = No --> <ServiceName>IPEC Local</ServiceName> <receiverAddress1>123 Test</receiverAddress1> <ShipperService>IPECL<<receiverAddress2></ShipperService>receiverAddress2> <receiverLocation>HALLAM</receiverLocation> <TaxCharge>189.0000</TaxCharge> <receiverPostcode>3803</receiverPostcode> <receiverCountryCode>AU</receiverCountryCode> <TotalCharge>2078.9900</TotalCharge> <receiverIsResidential>0</receiverIsResidential> <WebDescription>Toll Ipec Local</WebDescription> <!--Mandatory:Flags for whether the address is residential. Used to pre-empt residential delivery fees.--> <ZoneFrom>MEL1</ZoneFrom> <!-- <ZoneTo>IVIC</ZoneTo> 1 = Yes </ServicePricing> 0 = No <ServicePricing> --> <CalculatedSUType>UnDefined<<items>1</CalculatedSUType>items> <weight>4</weight> <CarrierID>101956</CarrierID> <volume>.001</volume> <CarrierName>TOLL IPEC PTY LTD</CarrierName><!--Mandatory:--> <time>0</time> <CarrierService>X</CarrierService> <ETA>16/08/2018</ETA><!--Optional:Estimated Travel Time. Recommended not to be used as inaccuracies in time calculation greatly vary quote results.--> <!-- <FeesCharge>261.2700</FeesCharge> 1 = Yes <FreightCharge>1820.6700</FreightCharge> 0 = No <ID>0</ID> --> <distance>0</distance> <NetCharge>2081.9400</NetCharge> <!--Optional: Estimated Distance between sender and receiver <RateID>9607176</RateID>locations. Recommended not to be used as inaccuracies in route taken greatly vary quote results. --> <ServiceName>IPEC Road Express</ServiceName> <!-- <ShipperService>IPECX</ShipperService> 1 = Yes <TaxCharge>208.2000</TaxCharge> 0 = No <TotalCharge>2290.1400</TotalCharge> --> <!-- <serviceList></serviceList> Optional: Only use <WebDescription>Tollif Ipecyou Roadwish Express</WebDescription>to filter different services --> <!--Optional: Concatenated <ZoneFrom>MEL1</ZoneFrom>string of active services for the current Session. Found by called GetStandardServices function. --> <ZoneTo>IVIC</ZoneTo> <containsDGs>0</containsDGs> </ServicePricing> <!--Mandatory:Flags whether shipping items contain dangerous goods. Required <ServicePricing>for compliance and dangerous goods handling fee calculations.--> <CalculatedSUType>UnDefined</CalculatedSUType> <!-- 1 <CarrierID>102958</CarrierID>= Yes 0 <CarrierName>Hi-Trans= ExpressNo Pty Ltd</CarrierName> --> <CarrierService>G<</CarrierService>GetChargeQuote3> </soapenv:Body> </soapenv:Envelope> <ETA/ |
Code Block | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <FeesCharge>327.8300</FeesCharge><GetChargeQuote3Response xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices"> <FreightCharge>1927.2900</FreightCharge><GetChargeQuote3Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <ID>0</ID><ServicePricing> <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> <TaxCharge>225.5100</TaxCharge> <CarrierService>EXP</CarrierService> <TotalCharge>2480.6300</TotalCharge> <ETA>02/08/2019</ETA> <WebDescription>Hi-Trans General</WebDescription> <FeesCharge>1.1300</FeesCharge> <ZoneFrom>MEL</ZoneFrom> <ZoneTo>VC1I<<FreightCharge>8.0400</ZoneTo>FreightCharge> </ServicePricing> <ID>0</ID> <ServicePricing> <CalculatedSUType>UnDefined</CalculatedSUType><NetCharge>9.1700</NetCharge> <CarrierID>102958</CarrierID> <RateID>15433078</RateID> <CarrierName>Hi-Trans Express Pty Ltd</CarrierName> <ServiceName>StarTrack Road Express</ServiceName> <CarrierService>X</CarrierService> <ShipperService>STEEXP</ShipperService> <ETA/> <FeesCharge>392<TaxCharge>0.8600<9100</FeesCharge>TaxCharge> <FreightCharge>2309.5900</FreightCharge> <TotalCharge>10.0800</TotalCharge> <ID>0</ID> <WebDescription>Startrack Road Express</WebDescription> <NetCharge>2702.4500</NetCharge> <RateID>10702460<<ZoneFrom>MEL</RateID>ZoneFrom> <ServiceName>Hi-Trans Express Service</ServiceName> <ZoneTo>MEL</ZoneTo> <ShipperService>HITRANX</ShipperService> </ServicePricing> <TaxCharge>270.2500</TaxCharge> <ServicePricing> <TotalCharge>2972.7000</TotalCharge> <CalculatedSUType>UnDefined</CalculatedSUType> <WebDescription>Hi Trans Express</WebDescription> <ZoneFrom>MEL<<CarrierID>106008</ZoneFrom>CarrierID> <ZoneTo>VC1I</ZoneTo> <CarrierName>StarTrack Express</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) | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...