2-31) Example Web Service Call (SavePickupRequest)

Warning

GetQuote5 returns the exact same information as GetQuote. 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

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

Headers:

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

Not Required

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

Body:

Web Service Call

<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:SavePickupRequest>
         <!--Optional:-->
         <cha:session>
            <!--Optional:-->
            <cha:AccountID>?</cha:AccountID>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:Expires>?</cha:Expires>
            <!--Optional:-->
            <cha:Key>?</cha:Key>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:session>
         <!--Optional:-->
         <cha:pickupRequest>
            <!--Optional:-->
            <cha:ActualItems>?</cha:ActualItems>
            <!--Optional:-->
            <cha:ActualPalletSpaces>?</cha:ActualPalletSpaces>
            <!--Optional:-->
            <cha:ActualVolume>?</cha:ActualVolume>
            <!--Optional:-->
            <cha:ActualWeight>?</cha:ActualWeight>
            <!--Optional:-->
            <cha:Cancelled>?</cha:Cancelled>
            <!--Optional:-->
            <cha:CancelledBy>?</cha:CancelledBy>
            <!--Optional:-->
            <cha:CarrierID>?</cha:CarrierID>
            <!--Optional:-->
            <cha:CloseAt>?</cha:CloseAt>
            <!--Optional:-->
            <cha:ConfirmationId>?</cha:ConfirmationId>
            <!--Optional:-->
            <cha:DetailItems>
               <!--Zero or more repetitions:-->
               <cha:PickupRequestDetail>
                  <!--Optional:-->
                  <cha:ConsignmentID>?</cha:ConsignmentID>
                  <!--Optional:-->
                  <cha:ConsignmentNote>?</cha:ConsignmentNote>
                  <!--Optional:-->
                  <cha:Items>?</cha:Items>
                  <!--Optional:-->
                  <cha:PickupRequestID>?</cha:PickupRequestID>
                  <!--Optional:-->
                  <cha:Volume>?</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>?</cha:Weight>
               </cha:PickupRequestDetail>
            </cha:DetailItems>
            <!--Optional:-->
            <cha:DetailedSUs>
               <!--Zero or more repetitions:-->
               <cha:Sus>
                  <!--Optional:-->
                  <cha:Barcode>?</cha:Barcode>
                  <!--Optional:-->
                  <cha:Height>?</cha:Height>
                  <!--Optional:-->
                  <cha:ItemNo>?</cha:ItemNo>
                  <!--Optional:-->
                  <cha:ItemType>?</cha:ItemType>
                  <!--Optional:-->
                  <cha:Length>?</cha:Length>
                  <!--Optional:-->
                  <cha:ReceiverAddress>
                     <!--Optional:-->
                     <cha:AccountID>?</cha:AccountID>
                     <!--Optional:-->
                     <cha:AddressID>?</cha:AddressID>
                     <!--Optional:-->
                     <cha:AddressLocation>
                        <!--Optional:-->
                        <cha:LocationID>?</cha:LocationID>
                        <!--Optional:-->
                        <cha:Locality>?</cha:Locality>
                        <!--Optional:-->
                        <cha:State>?</cha:State>
                        <!--Optional:-->
                        <cha:Postcode>?</cha:Postcode>
                        <!--Optional:-->
                        <cha:CountryCode>?</cha:CountryCode>
                        <!--Optional:-->
                        <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
                     </cha:AddressLocation>
                     <!--Optional:-->
                     <cha:ContactName>?</cha:ContactName>
                     <!--Optional:-->
                     <cha:Email>?</cha:Email>
                     <!--Optional:-->
                     <cha:Exception>
                        <!--Optional:-->
                        <cha:Message>?</cha:Message>
                        <!--Optional:-->
                        <cha:ModuleName>?</cha:ModuleName>
                        <!--Optional:-->
                        <cha:ProcedureName>?</cha:ProcedureName>
                     </cha:Exception>
                     <!--Optional:-->
                     <cha:Fax>?</cha:Fax>
                     <!--Optional:-->
                     <cha:Line1>?</cha:Line1>
                     <!--Optional:-->
                     <cha:Line2>?</cha:Line2>
                     <!--Optional:-->
                     <cha:Line3>?</cha:Line3>
                     <!--Optional:-->
                     <cha:LocationDetails>
                        <!--Optional:-->
                        <cha:LocationID>?</cha:LocationID>
                        <!--Optional:-->
                        <cha:Locality>?</cha:Locality>
                        <!--Optional:-->
                        <cha:State>?</cha:State>
                        <!--Optional:-->
                        <cha:Postcode>?</cha:Postcode>
                        <!--Optional:-->
                        <cha:CountryCode>?</cha:CountryCode>
                        <!--Optional:-->
                        <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
                     </cha:LocationDetails>
                     <!--Optional:-->
                     <cha:LocationID>?</cha:LocationID>
                     <!--Optional:-->
                     <cha:ModifiedBy>?</cha:ModifiedBy>
                     <!--Optional:-->
                     <cha:Name>?</cha:Name>
                     <!--Optional:-->
                     <cha:Phone>?</cha:Phone>
                     <!--Optional:-->
                     <cha:State>?</cha:State>
                     <!--Optional:-->
                     <cha:Suburb>?</cha:Suburb>
                  </cha:ReceiverAddress>
                  <!--Optional:-->
                  <cha:Reference>?</cha:Reference>
                  <!--Optional:-->
                  <cha:Volume>?</cha:Volume>
                  <!--Optional:-->
                  <cha:Weight>?</cha:Weight>
                  <!--Optional:-->
                  <cha:Width>?</cha:Width>
               </cha:Sus>
            </cha:DetailedSUs>
            <!--Optional:-->
            <cha:DistributorID>?</cha:DistributorID>
            <!--Optional:-->
            <cha:EdiFormat>?</cha:EdiFormat>
            <!--Optional:-->
            <cha:EstimatedItems>?</cha:EstimatedItems>
            <!--Optional:-->
            <cha:EstimatedPalletSpaces>?</cha:EstimatedPalletSpaces>
            <!--Optional:-->
            <cha:EstimatedVolume>?</cha:EstimatedVolume>
            <!--Optional:-->
            <cha:EstimatedWeight>?</cha:EstimatedWeight>
            <!--Optional:-->
            <cha:Exception>
               <!--Optional:-->
               <cha:Message>?</cha:Message>
               <!--Optional:-->
               <cha:ModuleName>?</cha:ModuleName>
               <!--Optional:-->
               <cha:ProcedureName>?</cha:ProcedureName>
            </cha:Exception>
            <!--Optional:-->
            <cha:FileName>?</cha:FileName>
            <!--Optional:-->
            <cha:Instructions>?</cha:Instructions>
            <!--Optional:-->
            <cha:PickupDate>?</cha:PickupDate>
            <!--Optional:-->
            <cha:PickupRequestID>?</cha:PickupRequestID>
            <!--Optional:-->
            <cha:ReadyAt>?</cha:ReadyAt>
            <!--Optional:-->
            <cha:Reference>?</cha:Reference>
            <!--Optional:-->
            <cha:Response>?</cha:Response>
            <!--Optional:-->
            <cha:SalesForceException>?</cha:SalesForceException>
            <!--Optional:-->
            <cha:SalesForceId>?</cha:SalesForceId>
            <!--Optional:-->
            <cha:Sender>
               <!--Optional:-->
               <cha:AccountID>?</cha:AccountID>
               <!--Optional:-->
               <cha:AddressID>?</cha:AddressID>
               <!--Optional:-->
               <cha:AddressLocation>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:AddressLocation>
               <!--Optional:-->
               <cha:ContactName>?</cha:ContactName>
               <!--Optional:-->
               <cha:Email>?</cha:Email>
               <!--Optional:-->
               <cha:Exception>
                  <!--Optional:-->
                  <cha:Message>?</cha:Message>
                  <!--Optional:-->
                  <cha:ModuleName>?</cha:ModuleName>
                  <!--Optional:-->
                  <cha:ProcedureName>?</cha:ProcedureName>
               </cha:Exception>
               <!--Optional:-->
               <cha:Fax>?</cha:Fax>
               <!--Optional:-->
               <cha:Line1>?</cha:Line1>
               <!--Optional:-->
               <cha:Line2>?</cha:Line2>
               <!--Optional:-->
               <cha:Line3>?</cha:Line3>
               <!--Optional:-->
               <cha:LocationDetails>
                  <!--Optional:-->
                  <cha:LocationID>?</cha:LocationID>
                  <!--Optional:-->
                  <cha:Locality>?</cha:Locality>
                  <!--Optional:-->
                  <cha:State>?</cha:State>
                  <!--Optional:-->
                  <cha:Postcode>?</cha:Postcode>
                  <!--Optional:-->
                  <cha:CountryCode>?</cha:CountryCode>
                  <!--Optional:-->
                  <cha:SuburbStatePostcode>?</cha:SuburbStatePostcode>
               </cha:LocationDetails>
               <!--Optional:-->
               <cha:LocationID>?</cha:LocationID>
               <!--Optional:-->
               <cha:ModifiedBy>?</cha:ModifiedBy>
               <!--Optional:-->
               <cha:Name>?</cha:Name>
               <!--Optional:-->
               <cha:Phone>?</cha:Phone>
               <!--Optional:-->
               <cha:State>?</cha:State>
               <!--Optional:-->
               <cha:Suburb>?</cha:Suburb>
            </cha:Sender>
            <!--Optional:-->
            <cha:SenderID>?</cha:SenderID>
            <!--Optional:-->
            <cha:ShipperID>?</cha:ShipperID>
            <!--Optional:-->
            <cha:SummaryItems>
               <!--Zero or more repetitions:-->
               <cha:PickupRequestSummary>
                  <!--Optional:-->
                  <cha:CarrierID>?</cha:CarrierID>
                  <!--Optional:-->
                  <cha:CarrierServiceCode>?</cha:CarrierServiceCode>
                  <!--Optional:-->
                  <cha:CartonCount>?</cha:CartonCount>
                  <!--Optional:-->
                  <cha:CartonWeight>?</cha:CartonWeight>
                  <!--Optional:-->
                  <cha:OtherCount>?</cha:OtherCount>
                  <!--Optional:-->
                  <cha:OtherWeight>?</cha:OtherWeight>
                  <!--Optional:-->
                  <cha:PalletCount>?</cha:PalletCount>
                  <!--Optional:-->
                  <cha:PalletWeight>?</cha:PalletWeight>
                  <!--Optional:-->
                  <cha:PickupRequestID>?</cha:PickupRequestID>
                  <!--Optional:-->
                  <cha:PickupRequestSummaryID>?</cha:PickupRequestSummaryID>
                  <!--Optional:-->
                  <cha:SalesForceException>?</cha:SalesForceException>
                  <!--Optional:-->
                  <cha:SalesForceId>?</cha:SalesForceId>
                  <!--Optional:-->
                  <cha:ServiceCode>?</cha:ServiceCode>
                  <!--Optional:-->
                  <cha:SuType>?</cha:SuType>
                  <!--Optional:-->
                  <cha:TotalItems>?</cha:TotalItems>
                  <!--Optional:-->
                  <cha:TotalWeight>?</cha:TotalWeight>
               </cha:PickupRequestSummary>
            </cha:SummaryItems>
            <!--Optional:-->
            <cha:TransferMethod>?</cha:TransferMethod>
            <!--Optional:-->
            <cha:TransferSettingsID>?</cha:TransferSettingsID>
            <!--Optional:-->
            <cha:Transferred>?</cha:Transferred>
            <!--Optional:-->
            <cha:TransmitErrorMessage>?</cha:TransmitErrorMessage>
            <!--Optional:-->
            <cha:UserID>?</cha:UserID>
         </cha:pickupRequest>
      </cha:SavePickupRequest>
   </soapenv:Body>
</soapenv:Envelope>

Successful Web Service Call Response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <GetChargeQuote5Response xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
         <GetChargeQuote4Result 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>
      </GetChargeQuote5Response>
   </s:Body>
</s:Envelope>

Related articles

Filter by label