Web Service Call - ConsignmentTrackingSearch

Owned by Steven Reynolds (Unlicensed)
Last updated: Jul 27, 2021 by Nathan Dam (Deactivated)
5 min read

Purpose:Make a request for the latest Scan Data on consignments in our system, allowing you to feed the most current carrier scan data into your system.

In this instance I am making a call to provide all information underneath a connote I require my Session credentials from my previous example to continue. This will allow me to perform future calls as this will provide me with "ConsignmentID"


*Learn how to chain this call in Creating Chained Requests


THIS CALL IS LIMITED TO 5 CALLS PER HOUR PER CONSIGNMENT.

  • WE ALSO RECOMMEND STOPPING ALL SUBSEQUENT API CALLS AFTER THE 'DEL' SCAN EVENT IS RECEIVED
    • OR 14 DAYS AFTER RELEASE (To Account for bad carrier Data)

Endpoint: https://uat-thirdpartywcf.flipgroup.com.au/DataService.svc

Headers: 

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:ConsignmentTrackingSearch>
  <!-- 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-16T15:15:55.89</cha:Expires>
            <!--Mandatory:-->
            <cha:Key>E36D344D-DCA9-45B8-8FCD-2F049B1E73B3</cha:Key>
            <!--Mandatory:-->
            <cha:UserID>64796</cha:UserID>
            <!--Mandatory:-->
         </cha:session>

         <cha:connoteReference>643655</cha:connoteReference>
         <!--Optional:-->
         <cha:consignmentDate>30/11/2017</cha:consignmentDate>
		 <!--Mandatory:-->
         <!--
            dd/mm/yyyy
            yyyy/mm/dd
            yy/mm/dd
            dd/mm/yy
            dd-mm-yyyy
            yyyy-mm-dd
            yy-mm-dd
            dd-mm-yy
        -->
      </cha:ConsignmentTrackingSearch>

   </soapenv:Body>
</soapenv:Envelope>

<cha:connoteReference></cha:connoteReference>
<cha:consignmentDate></cha:consignmentDate>

Information Can be found on the Track Consignments Page https://uat.oneflo.com.au/Tracking/

Successful Web Service Call Response 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <ConsignmentTrackingSearchResponse xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
         <ConsignmentTrackingSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <CarrierName/>
            <DateCreated>0001-01-01T00:00:00</DateCreated>
            <FileName/>
            <ManifestID>0</ManifestID>
            <ManifestItems>
               <ManifestItem>
                  <AutoBooked>false</AutoBooked>
                  <Consigned>2017-11-30T00:00:00</Consigned>
                  <ConsignmentID>43788027</ConsignmentID>
                  <ConsignmentNote>8479430000063</ConsignmentNote>
                  <Delivered/>
                  <Esn/>
                  <Eta>01/12/2017</Eta>
                  <Items>1</Items>
                  <LastScanType>Booking Sent To Carrier</LastScanType>
                  <Manifested>false</Manifested>
                  <PodView/>
                  <Receiver>Frank Ranaldo NORTHGATE SA 5085</Receiver>
                  <ReceiverContact>Malinda Dolling</ReceiverContact>
                  <ReceiverEmail>malinda@tomax.com.au</ReceiverEmail>
                  <ReceiverPhone>1300186629</ReceiverPhone>
                  <Reference>643655</Reference>
                  <References xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                     <a:string>643655</a:string>
                     <a:string>S136664</a:string>
                  </References>
                  <Release>false</Release>
                  <ReleasedAlReady>false</ReleasedAlReady>
                  <Scans/>
                  <Sender>TOMAX LOGISTICS  NOBLE PARK VIC 3174</Sender>
                  <SenderContact>Chris Chalmers</SenderContact>
                  <SenderEmail>chris@tomax.com.au</SenderEmail>
                  <SenderPhone>0395444227</SenderPhone>
                  <Service>IPEC Express</Service>
                  <SortCode/>
                  <SusItems/>
                  <ThirdPartyAccount/>
                  <Volume>0.457</Volume>
                  <Weight>21</Weight>
               </ManifestItem>
            </ManifestItems>
            <NoItems>0</NoItems>
            <Volume>0</Volume>
            <Weight>0</Weight>
         </ConsignmentTrackingSearchResult>
      </ConsignmentTrackingSearchResponse>
   </s:Body>
</s:Envelope>


Failed Web Service Call Response 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <ConsignmentTrackingSearchResponse xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
         <ConsignmentTrackingSearchResult i:nil="true" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"/>
      </ConsignmentTrackingSearchResponse>
   </s:Body>
</s:Envelope>

// Reason was due to an incomplete payload being called. i.e mismatching 
<cha:connoteReference></cha:connoteReference>
<cha:consignmentDate></cha:consignmentDate>