GET api/Track/{CompanyID}/{TrackingNumber}

Used to provide tracking information on public facing web site (non secure). Limited information is provided since the method can be access outside of the security restrictions.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CompanyID

The company ID that owns the tracking number

 integer

Required
TrackingNumber

The tracking number

 string

Required

Body Parameters

None.

Response Information

Resource Description

TrackingInfo
NameDescriptionTypeAdditional information
TrackingNumber

Contains the tracking number

 string

None.
StatusDescription

Contains the current status description of the shipment

 string

None.
DateOfShipment

The date the shipment is scheduled to be picked-up

 date

None.
Pieces

Number of pieces in shipment

 integer

None.
Weight

Total actual weight of shipment

 decimal number

None.
WeightUOM

Weight unit of measure (LB,KG)

 string

None.
PickupCityName

Name of pickup city

 string

None.
PickupStateProvID

State/province identifier at pickup

 string

None.
PickupCountryID

Country identifier at pickup

 string

None.
PickupCountryName

Country name at pickup

 string

None.
DeliveryCityName

Name of delivery city

 string

None.
DeliveryStateProvID

State/Provence identifer at delivery

 string

None.
DeliveryCountryID

Country identifier at delivery

 string

None.
DeliveryCountryName

Country name at delivery

 string

None.
Itinerary

The itinerary of the shipment

 Collection of ItineraryItem

None.
LocationLatitude

The current location of the shipment (latitude)

 decimal number

None.
LocationLongitude

The current location of the shipment (longitude)

 decimal number

None.
GpsTrackingUrl

TIVE (or other GPS device) web tracking page

 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.
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: 
{
  "TrackingNumber": "sample string 1",
  "StatusDescription": "sample string 2",
  "DateOfShipment": "2025-04-12T17:12:55.1915946+00:00",
  "Pieces": 4,
  "Weight": 1.0,
  "WeightUOM": "sample string 5",
  "PickupCityName": "sample string 6",
  "PickupStateProvID": "sample string 7",
  "PickupCountryID": "sample string 8",
  "PickupCountryName": "sample string 9",
  "DeliveryCityName": "sample string 10",
  "DeliveryStateProvID": "sample string 11",
  "DeliveryCountryID": "sample string 12",
  "DeliveryCountryName": "sample string 13",
  "Itinerary": [
    {
      "IsComplete": true,
      "StepName": "sample string 2",
      "StepDescription": "sample string 3",
      "CompletedUTC": "2025-04-12T17:12:55.2072117+00:00",
      "CompletedLocal": "2025-04-12T17:12:55.2072117+00:00"
    },
    {
      "IsComplete": true,
      "StepName": "sample string 2",
      "StepDescription": "sample string 3",
      "CompletedUTC": "2025-04-12T17:12:55.2072117+00:00",
      "CompletedLocal": "2025-04-12T17:12:55.2072117+00:00"
    }
  ],
  "LocationLatitude": 1.0,
  "LocationLongitude": 1.0,
  "GpsTrackingUrl": "sample string 14",
  "DepartAirportID": "sample string 15",
  "DepartAirlineName": "sample string 16",
  "DepartIataID": "sample string 17",
  "DepartFlightNumber": "sample string 18",
  "DepartEstimatedDateTime": "sample string 19",
  "DepartActualDateTime": "sample string 20",
  "ArriveAirportID": "sample string 21",
  "ArriveAirlineName": "sample string 22",
  "ArriveIataID": "sample string 23",
  "ArriveFlightNumber": "sample string 24",
  "ArriveEstimatedDateTime": "sample string 25",
  "ArriveActualDateTime": "sample string 26",
  "IsSuccessful": true,
  "ErrorMessage": "sample string 28"
}

application/xml, text/xml

Sample: 
<TrackingInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsSuccessful>true</IsSuccessful>
  <ErrorMessage>sample string 28</ErrorMessage>
  <TrackingNumber>sample string 1</TrackingNumber>
  <StatusDescription>sample string 2</StatusDescription>
  <DateOfShipment>2025-04-12T17:12:55.1915946+00:00</DateOfShipment>
  <Pieces>4</Pieces>
  <Weight>1</Weight>
  <WeightUOM>sample string 5</WeightUOM>
  <PickupCityName>sample string 6</PickupCityName>
  <PickupStateProvID>sample string 7</PickupStateProvID>
  <PickupCountryID>sample string 8</PickupCountryID>
  <PickupCountryName>sample string 9</PickupCountryName>
  <DeliveryCityName>sample string 10</DeliveryCityName>
  <DeliveryStateProvID>sample string 11</DeliveryStateProvID>
  <DeliveryCountryID>sample string 12</DeliveryCountryID>
  <DeliveryCountryName>sample string 13</DeliveryCountryName>
  <Itinerary>
    <ItineraryItem>
      <IsComplete>true</IsComplete>
      <StepName>sample string 2</StepName>
      <StepDescription>sample string 3</StepDescription>
      <CompletedUTC>2025-04-12T17:12:55.2072117+00:00</CompletedUTC>
      <CompletedLocal>2025-04-12T17:12:55.2072117+00:00</CompletedLocal>
    </ItineraryItem>
    <ItineraryItem>
      <IsComplete>true</IsComplete>
      <StepName>sample string 2</StepName>
      <StepDescription>sample string 3</StepDescription>
      <CompletedUTC>2025-04-12T17:12:55.2072117+00:00</CompletedUTC>
      <CompletedLocal>2025-04-12T17:12:55.2072117+00:00</CompletedLocal>
    </ItineraryItem>
  </Itinerary>
  <LocationLatitude>1</LocationLatitude>
  <LocationLongitude>1</LocationLongitude>
  <GpsTrackingUrl>sample string 14</GpsTrackingUrl>
  <DepartAirportID>sample string 15</DepartAirportID>
  <DepartAirlineName>sample string 16</DepartAirlineName>
  <DepartIataID>sample string 17</DepartIataID>
  <DepartFlightNumber>sample string 18</DepartFlightNumber>
  <DepartEstimatedDateTime>sample string 19</DepartEstimatedDateTime>
  <DepartActualDateTime>sample string 20</DepartActualDateTime>
  <ArriveAirportID>sample string 21</ArriveAirportID>
  <ArriveAirlineName>sample string 22</ArriveAirlineName>
  <ArriveIataID>sample string 23</ArriveIataID>
  <ArriveFlightNumber>sample string 24</ArriveFlightNumber>
  <ArriveEstimatedDateTime>sample string 25</ArriveEstimatedDateTime>
  <ArriveActualDateTime>sample string 26</ArriveActualDateTime>
</TrackingInfo>