Content Comparison

...

title	Warning

...

Purpose

Create/Save a consignment within the OneFlo System. This information will be stored within OneFlo, for Label Generation, Manifesting and Booking. subsequent steps can be done Manually in the App or via API

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
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

*Learn how to chain this call in 5) Creating Chained Requests

Endpoint: https://bau-uat-wsthirdpartywcf.flipgroup.azurewebsitescom.net/Dataau/ChainIT/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/GetChargeQuoteUsingXMLWithItems3SaveConsignment

...

Body:

title

Code Block
Not Required
Header declaration is not required for SoapUI. *SoapUI does this automatically

Body:

<soapenv:Envelope xmlns:soapenv="http

Code Block

xml

language	language	xml
theme	RDark
firstline	1
title	Web Service CallComplex Type Details
linenumbers	true

collapse	true

This is a complex type. For field information, please see https://schemasflipgroup.xmlsoapatlassian.orgnet/soapwiki/envelope/" xmlns:cha="http://spaces/OIUG/pages/716570801/2-0+Complex+Types#id-2-0)ComplexTypes-complextype_consignmentConsignment

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="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
    <soapenv:Header/>
    <soapenv:Body>
        <SaveConsignment>
         <session>
            <AccountID>{{AccountID}}</AccountID>
            <DistributorID>{{DistributorID}}</DistributorID>
            <Expires>{{Expires}}</Expires>
            <Key>{{Key}}</Key>
            <UserID>{{UserID}}</UserID>
         </session>

            <consignment>
                <AccountID>{{AccountID}}</AccountID>
                <AllowConsolidation>true</AllowConsolidation>
                <CloseAt>16:00</CloseAt>
                <ConsignmentDate>2019-10-19</ConsignmentDate>
                <ConsignmentItems>
                    <ConsignmentItem>
                        <ConsignmentProduct>
                            <Cubic>0.0152</Cubic>
                            <DangerousGoods>
                                <AggQty>4</AggQty>
                                <Class>2.1</Class>
                                <Group>NONE</Group>
                                <Name>AEROSOLS</Name>
                                <PSN>AEROSOLS IN A CAN</PSN>
                                <Qty>1</Qty>
                                <Receptacle>CAN</Receptacle>
                                <SubRisk>N/A</SubRisk>
             <cha:GetChargeQuoteUsingXMLWithItems3>       <!-- 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--><UnCode>1950</UnCode>
                                <Units>kg</Units>
  <cha:session>             <cha:AccountID>115860</cha:AccountID>             <!--Mandatory:-->/DangerousGoods>
                    <cha:DistributorID>101605</cha:DistributorID>    </ConsignmentProduct>
        <!--Mandatory:-->             <cha:Expires>2018-08-14T09:27:17.78</cha:Expires>   <Description>SMALL CARTON</Description>
        <!--Mandatory:-->                <cha:Key>D1F83B85-4EEE-4AD1-BC53-99E57836C246</cha:Key><Height>16</Height>         
   <!--Mandatory:-->             <cha:UserID>64796</cha:UserID>        <ItemNo>1</ItemNo>     <!--Mandatory:-->     
    </cha:session>            <cha:shipperID>115860</cha:shipperID>        <ItemType>SMALL  <!--Mandatory:-->CARTON</ItemType> 
         <cha:effectiveDate>15/08/2018</cha:effectiveDate>           <!--Mandatory:-->    <Length>38</Length>
     <cha:senderLocation>Nunawading</cha:senderLocation>          <!--Mandatory:-->         <cha:senderState>VIC</cha:senderState><NoItems>1</NoItems>
                <!--Mandatory:-->        <PackagingType>CTN</PackagingType> <!-- <cha:senderPostcode>3131</cha:senderPostcode>
         <!--Mandatory:https://flipgroup.atlassian.net/wiki/spaces/OIUG/pages/961445944/Shipping+Items+-+Packaging+Type -->
         <cha:senderCountryCode>AU</cha:senderCountryCode>
         <!--Mandatory:-->         <Reference <cha:senderIsResidential>0</cha:senderIsResidential>/>
          <!--Mandatory:Flags for whether the address is residential. Used to pre-empt residential pick up fees.-->
 <Weight>5</Weight>
        <!--              1 = Yes<Width>25</Width>
             0 = No     </ConsignmentItem>
    -->          <cha:receiverAddress1>18 Sycamore Grove</cha:receiverAddress1></ConsignmentItems>
				
         <!--Mandatory:-->       <DeliveryInstructions>Deliver to  <cha:receiverAddress2></cha:receiverAddress2>
 Front Door.</DeliveryInstructions>
       <!--Mandatory:-->         <Description <cha:receiverLocation>Narooma</cha:receiverLocation>
   />
     <!--Mandatory:-->            <cha:receiverState>NSW</cha:receiverState><DistributorID>101605</DistributorID>
				<Ext>
					<UserField1>123456</UserField1>
		<!--Mandatory:-->		</Ext>
                <cha<ReadyAt>14:receiverPostcode>2546</cha:receiverPostcode>
 00</ReadyAt>
			
			<Receiver>
				<AddressLocation>
       <!--Mandatory:-->          <cha:receiverCountryCode>AU</cha:receiverCountryCode>
 <Locality>Nunawading</Locality>
        <!--Mandatory:-->          <cha:receiverIsResidential>0</cha:receiverIsResidential><State>VIC</State>
             <!--Mandatory:Flags for whether the address is<Postcode>3131</Postcode>
residential. Used to pre-empt residential pick up fees.-->          <!--
  <CountryCode>AU</CountryCode>
				</AddressLocation>
           1 = Yes   <ContactName>Peter Test</ContactName>
         0 = No     <Email>test@email.com</Email>
    -->          <cha:items>4</cha:items>  <Line1>113 Rooks Rd</Line1>
     <!--Mandatory:-->          <cha:weight>18</cha:weight> <LocationDetails>
        <!--Mandatory:-->          <cha:volume>20</cha:volume><Locality>Nunawading</Locality>
           <!--Mandatory:-->       <State>VIC</State>
  <cha:time>0</cha:time>          <!--Optional:Estimated Travel Time. Recommended not to be<Postcode>3131</Postcode>
used as inaccuracies in time calculation greatly vary quote results.-->          <!--
			 1 = Yes
			 0 = No 
		 --><CountryCode>AU</CountryCode>
                </LocationDetails>
    <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. --> <Name>Steve</Name>
                <Phone>0425814806</Phone>
            <!-- 			 1 = Yes
			 0 = No 
		 --><State>VIC</State>
                <cha:serviceList>0</cha:serviceList><Suburb>Nunawading</Suburb>
            <!--Optional:-->
/Receiver>
			
        <cha:userID>64796</cha:userID>     <Reference>PO123456</Reference>
    <!--Mandatory:-->        <Released>2019-10-19</Released>
			
 <cha:itemsList>           <Sender>
 <!--Zero or more repetitions:-->           <AccountID>{{AccountID}}</AccountID>
  <cha:ConsignmentItem>             <AddressLocation>
  <!--Optional:-->                <cha:Barcode>1</cha:Barcode><Locality>Nunawading</Locality>
               <!--Optional:-->   <State>VIC</State>
            <cha:ConsignmentID>666666</cha:ConsignmentID>       <Postcode>3131</Postcode>
        <!--Optional:-->          <CountryCode>AU</CountryCode>
      <cha:ConsignmentProduct>         </AddressLocation>
         <!--Optional:-->      <ContactName>Peter  &amp; O"'"Connor</ContactName>
         <cha:AccountID>115860</cha:AccountID>      <Email>test@email.com</Email>
            <!--Optional:-->    <Line1>113 Rooks Rd</Line1>
            <cha:Code>1</cha:Code>   <LocationDetails>
               <!--Optional:-->   <Locality>Nunawading</Locality>
                <cha:DangerousGoods>  <State>VIC</State>
                   <!--Optional:--><Postcode>3131</Postcode>
                  <CountryCode>AU</CountryCode>
    <cha:AggrigateQuantity>1</cha:AggrigateQuantity>           </LocationDetails>
          <!--Optional:-->     <Name>Steven Reynolds</Name>
               <cha:ConsignmentID>1</cha:ConsignmentID><Phone>0425814806</Phone>
               <State>VIC</State>
      <!--Optional:-->         <Suburb>Nunawading</Suburb>
            <cha:DangerousGoodsID>1</cha:DangerousGoodsID></Sender>
			
                <Service>IPECL</Service>
     <!--Optional:-->           <SpecialInstructions/>
				
            <cha:DgClass>1</cha:DgClass></consignment>
        </SaveConsignment>
    </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/">
     <!--Optional:--><s:Body>
        <SaveConsignmentResponse xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
             <cha:Exception><SaveConsignmentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <AccountID>116911</AccountID>
        <!--Optional:-->        <AllowConsolidation>true</AllowConsolidation>
                <cha<CloseAt>16:Message>Na</cha:Message>
  08</CloseAt>
                <ConsignmentDate>2018-08-02</ConsignmentDate>
    <!--Optional:-->            <ConsignmentID>108802051</ConsignmentID>
            <cha:ModuleName>Peter</cha:ModuleName>    <ConsignmentItems>
                    <!--Optional:--><ConsignmentItem>
                        <cha:ProcedureName>Test</cha:ProcedureName><Barcode>TSTZ00000015EXP00001</Barcode>
                     </cha:Exception>   <ConsignmentID>108802051</ConsignmentID>
                  <!--Optional:-->      <ConsignmentProduct>
                <cha:Group>1</cha:Group>            <AccountID>0</AccountID>
         <!--Optional:-->                      <cha:ID>1</cha:ID><Code/>
                      <!--Optional:-->      <DangerousGoods i:nil="true"/>
              <cha:ItemNo>1</cha:ItemNo>              <DangerousGoodsID>0</DangerousGoodsID>
       <!--Optional:-->                     <Error <cha:LiquidVolume>1</cha:LiquidVolume>i:nil="true"/>
                     <!--Optional:-->        <Height>0</Height>
             <cha:Liquidweight>1</cha:Liquidweight>               <IsActive>true</IsActive>
      <!--Optional:-->                      <cha:Name>1</cha:Name><Length>0</Length>
                     <!--Optional:-->        <Name/>
             <cha:PSN>1</cha:PSN>               <ProductID>0</ProductID>
      <!--Optional:-->                      <cha:Quantity>1</cha:Quantity>
 <Volume>0</Volume>
                   <!--Optional:-->            <Weight>0</Weight>
         <cha:Recepticle>1</cha:Recepticle>                   <Width>0</Width>
  <!--Optional:-->                      <cha:SubRisk>1</cha:SubRisk></ConsignmentProduct>
                     <!--Optional:-->   <Description>SMALL CARTON</Description>
                 <cha:UnCode>1</cha:UnCode>       <ExchangeReturnable>false</ExchangeReturnable>
              <!--Optional:-->          <Height>16</Height>
           <cha:Units>1</cha:Units>             <ItemNo>1</ItemNo>
        <!--Optional:-->                <ItemType/>
     <cha:Volume>1</cha:Volume>                   <Length>38</Length>
  <!--Optional:-->                      <cha:Weight>1</cha:Weight><ModifiedBy>0</ModifiedBy>
                   </cha:DangerousGoods>     <NoItems>1</NoItems>
                 <!--Optional:-->       <ProductID>0</ProductID>
           <cha:DangerousGoodsID>1</cha:DangerousGoodsID>             <Reference>PO123456</Reference>
     <!--Mandatory:-->                   <Returnable/>
<cha:Error>                      <!--Optional:-->  <Volume>0.015</Volume>
                   <cha:Message>1</cha:Message>     <Weight>5</Weight>
                <!--Optional:-->        <Width>25</Width>
             <cha:ModuleName>1</cha:ModuleName>       </ConsignmentItem>
              <!--Optional:-->  </ConsignmentItems>
                <ConsignmentNote>TSTZ00000015</ConsignmentNote>
  <cha:ProcedureName>1</cha:ProcedureName>              <ConsignmentType/>
    </cha:Error>            <ConsolidatedSus>
       <!--Optional:-->             <ConsolidateConsignment>
     <cha:Height>1</cha:Height>                   <!--Optional:--><Height>16</Height>
                  <cha:IsActive>1</cha:IsActive>      <ItemType/>
            <!--Optional:-->            <Items>1</Items>
      <cha:Length>1</cha:Length>                   <!--Optional:--><Length>38</Length>
                  <cha:Name>1</cha:Name>      <Volume>0.015</Volume>
            <!--Optional:-->            <Weight>5</Weight>
      <cha:ProductID>1</cha:ProductID>                   <!--Optional:--><Width>25</Width>
                    <cha:Volume>1</cha:Volume></ConsolidateConsignment>
                </ConsolidatedSus>
    <!--Optional:-->            <ContainingConsignment>0</ContainingConsignment>
      <cha:Weight>1</cha:Weight>          <DeliveryInstructions>Deliver to Front Door.</DeliveryInstructions>
     <!--Optional:-->           <Description/>
       <cha:Width>1</cha:Width>         <DistributorID>101605</DistributorID>
      </cha:ConsignmentProduct>          <DownloadID>0</DownloadID>
     <!--Optional:-->           <Exception i:nil="true"/>
    <cha:Description>Enter Description</cha:Description>           <Ext>
    <!--Optional:-->                <cha:ExchangeReturnable>1</cha:ExchangeReturnable><ConsignmentID>0</ConsignmentID>
               <!--Optional:-->      <CostCenter/>
         <cha:Height>1</cha:Height>           <ThirdPartyAccount/>
    <!--Optional:-->                <cha:ItemNo>1</cha:ItemNo><UserField1/>
               <!--Optional:-->      <UserField2/>
         <cha:ItemType>1</cha:ItemType>           <UserField3/>
    <!--Optional:-->                <cha:Length>1</cha:Length><UserField4/>
                    <!--Optional:--<UserField5/>
               <cha:ModifiedBy>1</cha:ModifiedBy> </Ext>
                <!--Optional:--><ExtraInfo/>
                <cha:NoItems>1</cha:NoItems><Hours>0</Hours>
                <!--Optional:--><ModifiedBy>0</ModifiedBy>
                <cha:ProductID>1</cha:ProductID><NoItems>1</NoItems>
                 <!--Optional:--><OnForwarder>106008</OnForwarder>
                <cha:Reference>1</cha:Reference><PickupInstructions/>
                <!--Optional:--><ReadyAt>14:00</ReadyAt>
                <Receiver>
    <cha:Returnable>1</cha:Returnable>                <!--Optional:--><ATL>false</ATL>
               <cha:Volume>1</cha:Volume>     <AccountID>116911</AccountID>
          <!--Optional:-->          <AddressID>11400000</AddressID>
     <cha:Weight>1</cha:Weight>                <!--Optional:--><AddressLocation>
                <cha:Width>1</cha:Width>        <LocationID>8017</LocationID>
    </cha:ConsignmentItem>           </cha:itemsList>          <!--Optional:--><Locality>HALLAM</Locality>
           <cha:containsDGs>0</cha:containsDGs>                       <!--Mandatory:Flags whether shipping items<State>VIC</State>
contain dangerous goods. Required for compliance and dangerous goods handling fee calculations.-->          <!-- 			 1 =<Postcode>3803</Postcode>
Yes 			 0 = No  		 -->       </cha:GetChargeQuoteUsingXMLWithItems3>    </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>      <CountryCode>AU</CountryCode>
                        <SuburbStatePostcode>HALLAM VIC 3803</SuburbStatePostcode>
               <GetChargeQuote5Response xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">     </AddressLocation>
            <GetChargeQuote4Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">       <ContactName/>
     <ServicePricing>                <CalculatedSUType>UnDefined</CalculatedSUType><DefaultCarrierAccount i:nil="true"/>
                    <CarrierID>101956</CarrierID><Email>hallam@company.com.au</Email>
               <CarrierName>TOLL IPEC PTY LTD</CarrierName>    <Exception i:nil="true"/>
           <CarrierService>L</CarrierService>         <Fax/>
      <ETA>16/08/2018</ETA>              <Line1>89 Wellington <FeesCharge>237.1800<Street</FeesCharge>Line1>
               <FreightCharge>1652.8100</FreightCharge>     <Line2/>
          <ID>0</ID>          <Line3/>
     <NetCharge>1889.9900</NetCharge>               <LocationDetails>
<RateID>9607039</RateID>                <ServiceName>IPEC Local</ServiceName>       <LocationID>8017</LocationID>
        <ShipperService>IPECL</ShipperService>                <TaxCharge>189.0000<<Locality>HALLAM</TaxCharge>Locality>
               <TotalCharge>2078.9900</TotalCharge>         <State>VIC</State>
      <WebDescription>Toll Ipec Local</WebDescription>                <ZoneFrom>MEL1</ZoneFrom>
  <Postcode>3803</Postcode>
            <ZoneTo>IVIC</ZoneTo>              <<CountryCode>AU</ServicePricing>CountryCode>
            <ServicePricing>            <SuburbStatePostcode>HALLAM VIC 3803</SuburbStatePostcode>
 <CalculatedSUType>UnDefined</CalculatedSUType>                <CarrierID>101956</CarrierID>   </LocationDetails>
            <CarrierName>TOLL IPEC PTY LTD</CarrierName>     <LocationID>8017</LocationID>
          <CarrierService>X</CarrierService>          <ModifiedBy>0</ModifiedBy>
     <ETA>16/08/2018</ETA>               <Name>CUSTOMER <FeesCharge>261.2700</FeesCharge>F</Name>
                <FreightCharge>1820.6700</FreightCharge>    <Phone>03 6334 1000</Phone>
         <ID>0</ID>           <State>VIC</State>
    <NetCharge>2081.9400</NetCharge>                <RateID>9607176<<Suburb>HALLAM</RateID>Suburb>
               <ServiceName>IPEC Road Express</ServiceName></Receiver>
                <ShipperService>IPECX<<Reference>PO123456</ShipperService>Reference>
                <TaxCharge>208.2000</TaxCharge><References>
               <TotalCharge>2290.1400</TotalCharge>     <Reference>
          <WebDescription>Toll Ipec Road Express</WebDescription>           <ConsignmentReference>PO123456</ConsignmentReference>
    <ZoneFrom>MEL1</ZoneFrom>                <ZoneTo>IVIC</ZoneTo>    <RemoveReference>false</RemoveReference>
        </ServicePricing>            </Reference>
<ServicePricing>                <CalculatedSUType>UnDefined<</CalculatedSUType>References>
                <CarrierID>102958</CarrierID><Released>2019-08-01</Released>
               <CarrierName>Hi-Trans Express Pty Ltd</CarrierName><Sender>
               <CarrierService>G</CarrierService>     <ATL>false</ATL>
          <ETA/>            <AccountID>116911</AccountID>
   <FeesCharge>327.8300</FeesCharge>                 <FreightCharge>1927.2900</FreightCharge><AddressID>11399996</AddressID>
                   <ID>0</ID> <AddressLocation>
              <NetCharge>2255.1200</NetCharge>          <LocationID>5836</LocationID>
     <RateID>10702459</RateID>                <ServiceName>Hi Trans General Service<<Locality>SCORESBY</ServiceName>Locality>
                 <ShipperService>HITRANG</ShipperService>       <State>VIC</State>
        <TaxCharge>225.5100</TaxCharge>                <TotalCharge>2480.6300</TotalCharge><Postcode>3179</Postcode>
                <WebDescription>Hi-Trans General</WebDescription>       <CountryCode>AU</CountryCode>
        <ZoneFrom>MEL</ZoneFrom>                <ZoneTo>VC1I</ZoneTo><SuburbStatePostcode>SCORESBY VIC 3179</SuburbStatePostcode>
          </ServicePricing>          </AddressLocation>
  <ServicePricing>                <CalculatedSUType>UnDefined</CalculatedSUType>  <ContactName/>
             <CarrierID>102958</CarrierID>       <DefaultCarrierAccount i:nil="true"/>
       <CarrierName>Hi-Trans Express Pty Ltd</CarrierName>          <Email/>
     <CarrierService>X</CarrierService>                <ETA<Exception i:nil="true"/>
               <FeesCharge>392.8600</FeesCharge>     <Fax/>
           <FreightCharge>2309.5900</FreightCharge>         <Line1>7 Lakeview Drive</Line1>
    <ID>0</ID>                <NetCharge>2702.4500</NetCharge><Line2/>
                <RateID>10702460</RateID>    <Line3/>
           <ServiceName>Hi-Trans Express Service</ServiceName>       <LocationDetails>
        <ShipperService>HITRANX</ShipperService>                <TaxCharge>270.2500<<LocationID>5836</TaxCharge>LocationID>
               <TotalCharge>2972.7000</TotalCharge>         <Locality>SCORESBY</Locality>
      <WebDescription>Hi Trans Express</WebDescription>                <ZoneFrom>MEL<<State>VIC</ZoneFrom>State>
                 <ZoneTo>VC1I</ZoneTo>       <Postcode>3179</Postcode>
     </ServicePricing>              <ServicePricing>     <CountryCode>AU</CountryCode>
          <CalculatedSUType>UnDefined</CalculatedSUType>              <SuburbStatePostcode>SCORESBY VIC <CarrierID>101956<3179</CarrierID>SuburbStatePostcode>
               <CarrierName>TOLL IPEC PTY LTD</CarrierName>  </LocationDetails>
             <CarrierService>H</CarrierService>       <LocationID>5836</LocationID>
        <ETA>16/08/2018</ETA>            <ModifiedBy>0</ModifiedBy>
   <FeesCharge>766.2200</FeesCharge>                <FreightCharge>4895.9800</FreightCharge> <Name>SENDER ENTITY</Name>
             <ID>0</ID>       <Phone/>
        <NetCharge>5662.2000</NetCharge>            <State>VIC</State>
   <RateID>9606992</RateID>                <ServiceName>IPEC Priority<<Suburb>SCORESBY</ServiceName>Suburb>
                <ShipperService>IPECH<</ShipperService>Sender>
                <TaxCharge>566.2200</TaxCharge><Service>STEEXP</Service>
                <TotalCharge>6228.4200<<SessionID>0</TotalCharge>SessionID>
               <WebDescription>Toll Ipec Priority</WebDescription><SpecialInstructions/>
                <ZoneFrom>MEL1</ZoneFrom><Volume>0.015</Volume>
                <ZoneTo>IVIC<<Weight>5</ZoneTo>Weight>
            </ServicePricing>
SaveConsignmentResult>
        </GetChargeQuote4Result>SaveConsignmentResponse>
      </GetChargeQuote5Response>
   </s:Body>
</s:Envelope>

...

Version	Old Version 1	New Version Current
Changes made by	Steven Reynolds (Unlicensed)	Nathan Dam (Deactivated)
Saved on	Aug 15, 2018	Oct 24, 2021

Versions Compared

Key

Related articles