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

Name	Description	Type	Additional 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

Name	Description	Type	Additional 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.
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": "2024-09-19T09:17:01.2569533+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": "2024-09-19T09:17:01.2569533+00:00",
      "CompletedLocal": "2024-09-19T09:17:01.2569533+00:00"
    },
    {
      "IsComplete": true,
      "StepName": "sample string 2",
      "StepDescription": "sample string 3",
      "CompletedUTC": "2024-09-19T09:17:01.2569533+00:00",
      "CompletedLocal": "2024-09-19T09:17:01.2569533+00:00"
    }
  ],
  "LocationLatitude": 1.0,
  "LocationLongitude": 1.0,
  "IsSuccessful": true,
  "ErrorMessage": "sample string 15"
}

application/xml, text/xml

Sample:

<TrackingInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Shipper1.Models">
  <ErrorMessage>sample string 15</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <DateOfShipment>2024-09-19T09:17:01.2569533+00:00</DateOfShipment>
  <DeliveryCityName>sample string 10</DeliveryCityName>
  <DeliveryCountryID>sample string 12</DeliveryCountryID>
  <DeliveryCountryName>sample string 13</DeliveryCountryName>
  <DeliveryStateProvID>sample string 11</DeliveryStateProvID>
  <Itinerary>
    <ItineraryItem>
      <CompletedLocal>2024-09-19T09:17:01.2569533+00:00</CompletedLocal>
      <CompletedUTC>2024-09-19T09:17:01.2569533+00:00</CompletedUTC>
      <IsComplete>true</IsComplete>
      <StepDescription>sample string 3</StepDescription>
      <StepName>sample string 2</StepName>
    </ItineraryItem>
    <ItineraryItem>
      <CompletedLocal>2024-09-19T09:17:01.2569533+00:00</CompletedLocal>
      <CompletedUTC>2024-09-19T09:17:01.2569533+00:00</CompletedUTC>
      <IsComplete>true</IsComplete>
      <StepDescription>sample string 3</StepDescription>
      <StepName>sample string 2</StepName>
    </ItineraryItem>
  </Itinerary>
  <LocationLatitude>1</LocationLatitude>
  <LocationLongitude>1</LocationLongitude>
  <PickupCityName>sample string 6</PickupCityName>
  <PickupCountryID>sample string 8</PickupCountryID>
  <PickupCountryName>sample string 9</PickupCountryName>
  <PickupStateProvID>sample string 7</PickupStateProvID>
  <Pieces>4</Pieces>
  <StatusDescription>sample string 2</StatusDescription>
  <TrackingNumber>sample string 1</TrackingNumber>
  <Weight>1</Weight>
  <WeightUOM>sample string 5</WeightUOM>
</TrackingInfo>