Track Shipments


This web service operation allows an Estes customer to submit a request to track the current status of an Estes shipment.


Details

The Shipment Tracking web service provides an interface to the pre-existing Shipment Tracking API utilized by the external Estes website. All business rules related to tracking of a shipment are applied to web service shipment tracking requests just as they are for the website.

Service Operation

trackShipments – Submit a request to track the current status of an Estes shipment

Communication Pattern

Request/Reply(This is a communication pattern in which the service requester sends a request to the service provider. The service provider processes the request and sends a reply back to the requester. This is an on-time operation, meaning that there are no (long) time intervals between sending the request, the processing of the request and sending the reply.)

Preconditions
  1. A requester must have a valid My Estes user account and that account must have the appropriate privileges to call the shipment tracking web service.
  2. Minimal information required to retrieve the shipment status must be provided in the SOAP request to prevent the service from responding with errors.
Postconditions
  1. The shipment tracking request responds with information regarding the status of the specific shipment.
  2. Business validation errors are returned with a description for each.
Input

A valid shipment-identifying number is required.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ship="http://ws.estesexpress.com/shipmenttracking" xmlns:ship1="http://ws.estesexpress.com/schema/2012/12/shipmenttracking">
   <soapenv:Header>
      <ship:auth>
         <ship:user>username</ship:user>
         <ship:password>password</ship:password>
      </ship:auth>
   </soapenv:Header>
   <soapenv:Body>
      <ship1:search>
         <ship1:requestID>987654321</ship1:requestID>
         <!--You have a CHOICE of the next 5 items at this level-->
         <ship1:pro>123-1234567</ship1:pro>
         <!--ship1:bol>BOL1234</ship1:bol>
         <ship1:po>PO1234</ship1:po>
         <ship1:loadNumber>LDN1234</ship1:loadNumber>
         <ship1:interlinePro>123-1234567</ship1:interlinePro-->
      </ship1:search>
   </soapenv:Body>
</soapenv:Envelope>
Output

The operation will respond with the following format if the shipment information has been retrieved from the Estes Shipment Tracking system.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ship:trackingInfo xmlns:ship="http://ws.estesexpress.com/schema/2012/12/shipmenttracking">
         <ship:requestID>allenle2013-01-21.1643</ship:requestID>
         <ship:shipments>
            <ship:shipment>
               <ship:pro>074-9149083</ship:pro>
               <ship:bol>CVL833248</ship:bol>
               <ship:po>HAA80286</ship:po>
               <ship:pickupDate>2011-08-16-04:00</ship:pickupDate>
               <ship:status>Delivered</ship:status>
               <ship:firstDeliveryDate>2011-08-23-04:00</ship:firstDeliveryDate>
               <ship:deliveryDate>2011-08-23-04:00</ship:deliveryDate>
               <ship:deliveryTime>09:53:00.000-05:00</ship:deliveryTime>
               <ship:receivedBy>TRACY</ship:receivedBy>
               <ship:appointment>
                  <ship:apptDate>2011-08-23-04:00</ship:apptDate>
                  <ship:apptTime>12:00:00.000-05:00</ship:apptTime>
                  <ship:status>Customer requested appointment</ship:status>
               </ship:appointment>
               <ship:pieces>1</ship:pieces>
               <ship:weight>378</ship:weight>
               <ship:shipper>
                  <ship:name>S K F USA INCORPORATED</ship:name>
                  <ship:address>
                     <ship:line1>1536 GENESIS ROAD</ship:line1>
                     <ship:city>CROSSVILLE</ship:city>
                     <ship:stateProvince>TN</ship:stateProvince>
                     <ship:postalCode>38555</ship:postalCode>
                  </ship:address>
               </ship:shipper>
               <ship:consignee>
                  <ship:name>CATERPILLAR INC</ship:name>
                  <ship:address>
                     <ship:line1>2800 E CEDAR HILLS DR</ship:line1>
                     <ship:line2/>
                     <ship:city>MOSSVILLE</ship:city>
                     <ship:stateProvince>IL</ship:stateProvince>
                     <ship:postalCode>61552</ship:postalCode>
                  </ship:address>
               </ship:consignee>
               <ship:destinationTerminal>
                  <ship:number>66</ship:number>
                  <ship:name>Bloomington</ship:name>
                  <ship:address>
                     <ship:line1>2150 North Main Street</ship:line1>
                     <ship:city>Normal</ship:city>
                     <ship:stateProvince>IL</ship:stateProvince>
                     <ship:postalCode>61761</ship:postalCode>
                  </ship:address>
                  <ship:phone>
                     <ship:areaCode>309</ship:areaCode>
                     <ship:subscriber>8623311</ship:subscriber>
                  </ship:phone>
                  <ship:fax>
                     <ship:areaCode>309</ship:areaCode>
                     <ship:subscriber>8623332</ship:subscriber>
                  </ship:fax>
               </ship:destinationTerminal>
               <ship:messages>
                  <ship:message>Reported delivery time is subject to change based upon verification.</ship:message>
               </ship:messages>
            </ship:shipment>
         </ship:shipments>
      </ship:trackingInfo>
   </soapenv:Body>
</soapenv:Envelope>
Error message response

If the user is not authorized to the web service authentication will fail. If the username and password provided is not from a valid and active My Estes profile then authentication will fail.

In the event that a business validation rule is violated, an error description will be returned to the user in the following format:

      <soapenv:Fault>
         <faultcode>soapenv:Server</faultcode>
         <faultstring>GeneralErrorMsg</faultstring>
         <detail>
            <ship:generalError xmlns:ship="http://ws.estesexpress.com/shipmenttracking">
               <ship:error>Shipment tracking failed - Invalid PRO number.</ship:error>
            </ship:generalError>
         </detail>
      </soapenv:Fault>>