GET api/Track/{UserGUID}/{TrackingNumber}/{TimeFormat}

Use this method to get detailed status information regarding your shipment. This is a secure method that requires a UserGUID parameter for authentication.

Request Information

URI Parameters

Name	Description	Type	Additional information
UserGUID	Unique user identifier used to authenticate your request for status	string	Required
TrackingNumber	The tracking number you are trying to get status information	string	Required
TimeFormat	Format of all times return in status ("12"=12 hour format, "24"=24 hour format)	string	Required

Body Parameters

None.

Response Information

Resource Description

GetStatusResponse

Name	Description	Type	Additional information
ShipmentNumber	Unique shipment number assigned by the system to each order	integer	Required
TrackingNumber	Tracking number or (air)waybill number, this is optional, typically the ShipmentNumber is the main tracking number for the shipment	string	None.
Pieces	Number of pieces in the shipment	integer	Required
Weight	Total actual weight of the shipment	decimal number	None.
WeightUOM	Weight unit of measure (LB,KG)	string	None.
ServiceCode	Code of the service required for shipment	string	Required Max length: 15
ServiceName	Name of the service used for shipment	string	Required Max length: 40
Contents	The description of the contents at of the shipment	string	Max length: 100
Reference	Customer specified reference value for the shipment	string	Max length: 50
OtherReference1	Custom reference value	string	Max length: 50
OtherReference2	Custom reference value	string	Max length: 50
OtherReference3	Custom reference value	string	Max length: 50
OtherReference4	Custom reference value	string	Max length: 50
OtherReference5	Custom reference value	string	Max length: 50
OtherReference6	Custom reference value	string	Max length: 50
OtherReference7	Custom reference value	string	Max length: 50
OtherReference8	Custom reference value	string	Max length: 50
PickupCompanyName	The name of the company at the pickup location	string	Required Max length: 50
PickupAddress1	Address line 1 at the pickup location	string	Max length: 50
PickupAddress2	Address line 2 at the pickup location	string	Max length: 50
PickupAddress3	Address line 3 at the pickup location	string	Max length: 50
PickupCityName	The city name at the pickup location	string	Required Max length: 50
PickupStateProvID	The state or province at the pickup location	string	Max length: 3
PickupPostalCode	The postal code at the pickup location	string	Max length: 10
PickupCountryID	The country identifier at the pickup location	string	Required Max length: 2
PickupCountryName	The name of the country	string	Max length: 30
PickupPersonToSee	The person to see at the pickup location	string	Max length: 50
PickupPhoneNumber	The phone number at the pickup location	string	Max length: 25
DeliveryCompanyName	The name of the company at the pickup location	string	Required Max length: 50
DeliveryAddress1	The address line 1 at the delivery location	string	Max length: 50
DeliveryAddress2	The address line 2 at the delivery location	string	Max length: 50
DeliveryAddress3	The address line 3 at the delivery location	string	Max length: 50
DeliveryCityName	The name of the city at the delivery location	string	Required Max length: 50
DeliveryStateProvID	The state or province at the delivery location	string	Max length: 3
DeliveryPostalCode	The postal code at the delivery location	string	Max length: 10
DeliveryCountryID	The country ID at the delivery location (ie. US)	string	Required Max length: 2
DeliveryCountryName	The country name at the delivery location (ie. US)	string	Required Max length: 30
DeliveryAttention	The attention to person at the delivery location	string	Max length: 50
DeliveryPhoneNumber	The phone number at the delivery location	string	Max length: 25
DeliveryEmailAddress	The email address at the delivery location	string	Max length: 100
ReadyDateTime	The date/time the shipment will be ready in the timezone of the pickup	string	Required
EstimatedPickupDateTime	The estimated date/time of pickup in the timezone of the pickup	string	Required
ActualPickupDateTime	The actual date/time of pickup in the timezone of the pickup	string	None.
EstimatedDeliveryDateTime	The estimated date/time of delivery in the timezone of the delivery	string	None.
PodSignature	The proof of delivery signature	string	None.
PodDateTime	The actual delivery date/time in timezone of the delivery	string	None.
OrderStatus	The status (code) of the order	string	Required
OrderStatusName	The current status description of the shipment	string	None.
DepartAirportID	Departing airport code	string	Max length: 3
DepartAirlineName	Departing airline name	string	None.
DepartIataID	Departing airline code	string	None.
DepartFlightNumber	Departing flight number	string	None.
DepartEstimatedDateTime	Estimated depart date/time in timezone of departing airport	string	None.
DepartActualDateTime	Actual depart date/time in timezone of departing airport	string	None.
ArriveAirportID	Arriving airport code	string	Max length: 3
ArriveAirlineName	Arrivaing airline name	string	None.
ArriveIataID	Arriving airline code	string	None.
ArriveFlightNumber	Arriving flight number	string	None.
ArriveEstimatedDateTime	Estimated arrival time in timezone of arriving airport	string	None.
ArriveActualDateTime	Actual arrival time in timezone of arriving airport	string	None.
OrderReceivedDateTimeUTC	The date/time that the order was received in the system (UTC time)	string	None.
IsSuccessful	If true, then method call was successful	boolean	None.
ErrorMessage	Contains an error message is method call failed	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ShipmentNumber": 1,
  "TrackingNumber": "sample string 2",
  "Pieces": 1,
  "Weight": 1.0,
  "WeightUOM": "sample string 3",
  "ServiceCode": "sample string 4",
  "ServiceName": "sample string 5",
  "Contents": "sample string 6",
  "Reference": "sample string 7",
  "OtherReference1": "sample string 8",
  "OtherReference2": "sample string 9",
  "OtherReference3": "sample string 10",
  "OtherReference4": "sample string 11",
  "OtherReference5": "sample string 12",
  "OtherReference6": "sample string 13",
  "OtherReference7": "sample string 14",
  "OtherReference8": "sample string 15",
  "PickupCompanyName": "sample string 16",
  "PickupAddress1": "sample string 17",
  "PickupAddress2": "sample string 18",
  "PickupAddress3": "sample string 19",
  "PickupCityName": "sample string 20",
  "PickupStateProvID": "sample string 21",
  "PickupPostalCode": "sample string 22",
  "PickupCountryID": "sample string 23",
  "PickupCountryName": "sample string 24",
  "PickupPersonToSee": "sample string 25",
  "PickupPhoneNumber": "sample string 26",
  "DeliveryCompanyName": "sample string 27",
  "DeliveryAddress1": "sample string 28",
  "DeliveryAddress2": "sample string 29",
  "DeliveryAddress3": "sample string 30",
  "DeliveryCityName": "sample string 31",
  "DeliveryStateProvID": "sample string 32",
  "DeliveryPostalCode": "sample string 33",
  "DeliveryCountryID": "sample string 34",
  "DeliveryCountryName": "sample string 35",
  "DeliveryAttention": "sample string 36",
  "DeliveryPhoneNumber": "sample string 37",
  "DeliveryEmailAddress": "sample string 38",
  "ReadyDateTime": "sample string 39",
  "EstimatedPickupDateTime": "sample string 40",
  "ActualPickupDateTime": "sample string 41",
  "EstimatedDeliveryDateTime": "sample string 42",
  "PodSignature": "sample string 43",
  "PodDateTime": "sample string 44",
  "OrderStatus": "sample string 45",
  "OrderStatusName": "sample string 46",
  "DepartAirportID": "sample string 47",
  "DepartAirlineName": "sample string 48",
  "DepartIataID": "sample string 49",
  "DepartFlightNumber": "sample string 50",
  "DepartEstimatedDateTime": "sample string 51",
  "DepartActualDateTime": "sample string 52",
  "ArriveAirportID": "sample string 53",
  "ArriveAirlineName": "sample string 54",
  "ArriveIataID": "sample string 55",
  "ArriveFlightNumber": "sample string 56",
  "ArriveEstimatedDateTime": "sample string 57",
  "ArriveActualDateTime": "sample string 58",
  "OrderReceivedDateTimeUTC": "sample string 59",
  "IsSuccessful": true,
  "ErrorMessage": "sample string 61"
}

application/xml, text/xml

Sample:

<GetStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.ShipperPortal.Models">
  <ErrorMessage>sample string 61</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <ActualPickupDateTime>sample string 41</ActualPickupDateTime>
  <ArriveActualDateTime>sample string 58</ArriveActualDateTime>
  <ArriveAirlineName>sample string 54</ArriveAirlineName>
  <ArriveAirportID>sample string 53</ArriveAirportID>
  <ArriveEstimatedDateTime>sample string 57</ArriveEstimatedDateTime>
  <ArriveFlightNumber>sample string 56</ArriveFlightNumber>
  <ArriveIataID>sample string 55</ArriveIataID>
  <Contents>sample string 6</Contents>
  <DeliveryAddress1>sample string 28</DeliveryAddress1>
  <DeliveryAddress2>sample string 29</DeliveryAddress2>
  <DeliveryAddress3>sample string 30</DeliveryAddress3>
  <DeliveryAttention>sample string 36</DeliveryAttention>
  <DeliveryCityName>sample string 31</DeliveryCityName>
  <DeliveryCompanyName>sample string 27</DeliveryCompanyName>
  <DeliveryCountryID>sample string 34</DeliveryCountryID>
  <DeliveryCountryName>sample string 35</DeliveryCountryName>
  <DeliveryEmailAddress>sample string 38</DeliveryEmailAddress>
  <DeliveryPhoneNumber>sample string 37</DeliveryPhoneNumber>
  <DeliveryPostalCode>sample string 33</DeliveryPostalCode>
  <DeliveryStateProvID>sample string 32</DeliveryStateProvID>
  <DepartActualDateTime>sample string 52</DepartActualDateTime>
  <DepartAirlineName>sample string 48</DepartAirlineName>
  <DepartAirportID>sample string 47</DepartAirportID>
  <DepartEstimatedDateTime>sample string 51</DepartEstimatedDateTime>
  <DepartFlightNumber>sample string 50</DepartFlightNumber>
  <DepartIataID>sample string 49</DepartIataID>
  <EstimatedDeliveryDateTime>sample string 42</EstimatedDeliveryDateTime>
  <EstimatedPickupDateTime>sample string 40</EstimatedPickupDateTime>
  <OrderReceivedDateTimeUTC>sample string 59</OrderReceivedDateTimeUTC>
  <OrderStatus>sample string 45</OrderStatus>
  <OrderStatusName>sample string 46</OrderStatusName>
  <OtherReference1>sample string 8</OtherReference1>
  <OtherReference2>sample string 9</OtherReference2>
  <OtherReference3>sample string 10</OtherReference3>
  <OtherReference4>sample string 11</OtherReference4>
  <OtherReference5>sample string 12</OtherReference5>
  <OtherReference6>sample string 13</OtherReference6>
  <OtherReference7>sample string 14</OtherReference7>
  <OtherReference8>sample string 15</OtherReference8>
  <PickupAddress1>sample string 17</PickupAddress1>
  <PickupAddress2>sample string 18</PickupAddress2>
  <PickupAddress3>sample string 19</PickupAddress3>
  <PickupCityName>sample string 20</PickupCityName>
  <PickupCompanyName>sample string 16</PickupCompanyName>
  <PickupCountryID>sample string 23</PickupCountryID>
  <PickupCountryName>sample string 24</PickupCountryName>
  <PickupPersonToSee>sample string 25</PickupPersonToSee>
  <PickupPhoneNumber>sample string 26</PickupPhoneNumber>
  <PickupPostalCode>sample string 22</PickupPostalCode>
  <PickupStateProvID>sample string 21</PickupStateProvID>
  <Pieces>1</Pieces>
  <PodDateTime>sample string 44</PodDateTime>
  <PodSignature>sample string 43</PodSignature>
  <ReadyDateTime>sample string 39</ReadyDateTime>
  <Reference>sample string 7</Reference>
  <ServiceCode>sample string 4</ServiceCode>
  <ServiceName>sample string 5</ServiceName>
  <ShipmentNumber>1</ShipmentNumber>
  <TrackingNumber>sample string 2</TrackingNumber>
  <Weight>1</Weight>
  <WeightUOM>sample string 3</WeightUOM>
</GetStatusResponse>