Notewarning |
---|
| GetChargeQuote4 and GetChargeQuote5 returns |
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 |
---|
| 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: - My Session Credentials form my previous Login Call
- Note Session Credentials will expire If
- You Have generated a new "Key"
- You Have Passed the Expiry Date of the Session
- The User has been Deleted/made inactive
- 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
...
...
...
Body:
Code Block |
---|
language | xml |
---|
theme | RDark |
---|
firstline | 1 |
---|
title | Web Service Call |
---|
linenumbers | 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>">
<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: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:GetChargeQuote4>:shipperID>115860</cha:shipperID>
<!-- Session Credentials Available By following the "Login Web Service Call" --Mandatory:-->
<cha:effectiveDate>15/08/2018</cha:effectiveDate>
<!--Mandatory:-->
<cha:senderLocation>Nunawading</cha:senderLocation>
<cha:session>
<!--Mandatory:-->
<cha:AccountID>115860<senderPostcode>3131</cha:AccountID>
senderPostcode>
<!--Mandatory:-->
<cha:DistributorID>101605<senderCountryCode>AU</cha:DistributorID>senderCountryCode>
<!--Mandatory:-->
<cha:Expires>2018-08-14T09:27:17.78<senderIsResidential>0</cha:Expires>senderIsResidential>
<!--Mandatory:-->Flags for whether the address is residential. Used <cha:Key>D1F83B85-4EEE-4AD1-BC53-99E57836C246</cha:Key>
to pre-empt residential pick up fees.-->
<!--Mandatory:-->
<cha:UserID>64796</cha:UserID>
1 = Yes
<!--Mandatory:--> 0 = No
</cha:session> -->
<cha:shipperID>115860<receiverAddress1>18 Sycamore Grove</cha:shipperID>receiverAddress1>
<!--OptionalMandatory:-->
<cha:effectiveDate>15/08/2018<receiverAddress2></cha:effectiveDate>receiverAddress2>
<!--OptionalMandatory:-->
<cha:senderLocation>Nunawading<receiverLocation>Narooma</cha:senderLocation>receiverLocation>
<!--OptionalMandatory:-->
<cha:senderPostcode>3131<receiverPostcode>2546</cha:senderPostcode>receiverPostcode>
<!--OptionalMandatory:-->
<cha:senderCountryCode>AU<receiverCountryCode>AU</cha:senderCountryCode>receiverCountryCode>
<!--OptionalMandatory:-->
<cha:senderIsResidential>0<receiverIsResidential>0</cha:senderIsResidential>receiverIsResidential>
<!--Optional:-->
<cha:receiverAddress1>18 Sycamore Grove</cha:receiverAddress1>Mandatory:Flags for whether the address is residential. Used to pre-empt residential pick up fees.-->
<!--Optional:-->
<cha:receiverAddress2/> 1 = Yes
<!--Optional:--> 0 <cha:receiverLocation>MOUNT EVELYN</cha:receiverLocation>= No
<!--Optional:-->
<cha:receiverPostcode>3796<items>4</cha:receiverPostcode>items>
<!--OptionalMandatory:-->
<cha:receiverCountryCode>AU<weight>18</cha:receiverCountryCode>weight>
<!--OptionalMandatory:-->
<cha:receiverIsResidential>0<volume>20</cha:receiverIsResidential>volume>
<!--OptionalMandatory:-->
<cha:items>4<time>0</cha:items>time>
<!--Optional:Estimated Travel Time. Recommended not to be used as inaccuracies in time calculation greatly vary quote results.-->
<cha:weight>18</cha:weight>
<!--Optional:<!--
1 = Yes
0 = No
-->
<cha:volume>20<distance>0</cha:volume>distance>
<!--Optional:-->
<cha:time>0</cha:time>
<!--Optional:-- Estimated Distance between sender and receiver locations. Recommended not to be used as inaccuracies in route taken greatly vary quote results. -->
<cha:distance>0</cha:distance>
<!--Optional:--><!--
1 = Yes
0 = No
-->
<!-- <cha:serviceList>0</cha:serviceList> Optional: Only use if you wish to filter different services -->
<!--Optional:-->
<cha:userID>64796</cha:userID>
<!--OptionalMandatory:-->
<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><AggrigateQuantity>1</cha:AggrigateQuantity>
<!--Optional:-->
<cha:ConsignmentID><ConsignmentID>1</cha:ConsignmentID>
<!--Optional:-->
<cha:DangerousGoodsID><DangerousGoodsID>1</cha:DangerousGoodsID>
<!--Optional:-->
<cha:DgClass><DgClass>1</cha:DgClass>
<!--Optional:-->
<cha:Exception>
<!--Optional:-->
<cha:Message><Message>Na</cha:Message>
<!--Optional:-->
<cha:ModuleName><ModuleName>Peter</cha:ModuleName>
<!--Optional:-->
<cha:ProcedureName><ProcedureName>Test</cha:ProcedureName>
</cha:Exception>
<!--Optional:-->
<cha:Group><Group>1</cha:Group>
<!--Optional:-->
<cha:ID><ID>1</cha:ID>
<!--Optional:-->
<cha:ItemNo><ItemNo>1</cha:ItemNo>
<!--Optional:-->
<cha:LiquidVolume><LiquidVolume>1</cha:LiquidVolume>
<!--Optional:-->
<cha:Liquidweight><Liquidweight>1</cha:Liquidweight>
<!--Optional:-->
<cha:Name><Name>1</cha:Name>
<!--Optional:-->
<cha:PSN><PSN>1</cha:PSN>
<!--Optional:-->
<cha:Quantity><Quantity>1</cha:Quantity>
<!--Optional:-->
<cha:Recepticle><Recepticle>1</cha:Recepticle>
<!--Optional:-->
<cha:SubRisk><SubRisk>1</cha:SubRisk>
<!--Optional:-->
<cha:UnCode><UnCode>1</cha:UnCode>
<!--Optional:-->
<cha:Units><Units>1</cha:Units>
<!--Optional:-->
<cha:Volume><Volume>1</cha:Volume>
<!--Optional:-->
<cha:Weight><Weight>1</cha:Weight>
</cha:DangerousGoods>
<!--Optional:-->
<cha:DangerousGoodsID>1</cha:DangerousGoodsID>
<!--OptionalMandatory:-->
<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:ConsignmentItem>
</cha:itemsList>goods. Required for compliance and dangerous goods handling fee calculations.-->
<!--Optional:-->
<cha:containsDGs>0</cha:containsDGs>
1 = Yes
0 = No
-->
</cha:GetChargeQuote4>
</soapenv:Body>
</soapenv:Envelope> |
...
Code Block |
---|
language | xml |
---|
theme | RDark |
---|
firstline | 1 |
---|
title | Successful Web Service Call Response |
---|
linenumbers | true |
---|
collapse | true |
---|
|
<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> |
Related articles
Filter by label (Content by label) |
---|
showLabels | false |
---|
max | 5 |
---|
spaces | com.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@20f86d |
---|
showSpace | false |
---|
sort | modified |
---|
reverse | true |
---|
type | page |
---|
cql | label = "kb-how-to-article" and type = "page" and space = "FLIP" |
---|
labels | kb-how-to-article |
---|
|
...