GET api/TrackShipment/{trackingNumber}

Request Information

URI Parameters

Name	Type	Description	Additional information
trackingNumber	string		Required

Body Parameters

None

Response Information

Resource Description

TrackingResponseV3

Name	Type	Description	Additional information
trackingBarcodeNumber	string
trackingNumber	string
status	string
trackingUrl	string
carrierName	string
trackingDetails	Collection of TrackingDetailV3

Response Formats

application/json, text/json

Sample:

{
  "trackingBarcodeNumber": "sample string 1",
  "trackingNumber": "sample string 2",
  "status": "sample string 3",
  "trackingUrl": "sample string 4",
  "carrierName": "sample string 5",
  "trackingDetails": [
    {
      "message": "sample string 1",
      "status": "sample string 2",
      "dateTime": "2025-01-18T04:56:59.2961621+00:00",
      "dateTimeWithTimeZone": "2025-01-18T04:56:59.2961621+00:00",
      "city": "sample string 3",
      "state": "sample string 4",
      "country": "sample string 5",
      "zip": "sample string 6",
      "carrierStatusCode": "sample string 7",
      "carrierStatusDesc": "sample string 8"
    },
    {
      "message": "sample string 1",
      "status": "sample string 2",
      "dateTime": "2025-01-18T04:56:59.2961621+00:00",
      "dateTimeWithTimeZone": "2025-01-18T04:56:59.2961621+00:00",
      "city": "sample string 3",
      "state": "sample string 4",
      "country": "sample string 5",
      "zip": "sample string 6",
      "carrierStatusCode": "sample string 7",
      "carrierStatusDesc": "sample string 8"
    }
  ]
}

application/xml, text/xml

Sample:

<TrackingResponseV3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <trackingBarcodeNumber>sample string 1</trackingBarcodeNumber>
  <trackingNumber>sample string 2</trackingNumber>
  <status>sample string 3</status>
  <trackingUrl>sample string 4</trackingUrl>
  <carrierName>sample string 5</carrierName>
  <trackingDetails>
    <TrackingDetailV3>
      <message>sample string 1</message>
      <status>sample string 2</status>
      <dateTime>2025-01-18T04:56:59.2961621+00:00</dateTime>
      <dateTimeWithTimeZone />
      <city>sample string 3</city>
      <state>sample string 4</state>
      <country>sample string 5</country>
      <zip>sample string 6</zip>
      <carrierStatusCode>sample string 7</carrierStatusCode>
      <carrierStatusDesc>sample string 8</carrierStatusDesc>
    </TrackingDetailV3>
    <TrackingDetailV3>
      <message>sample string 1</message>
      <status>sample string 2</status>
      <dateTime>2025-01-18T04:56:59.2961621+00:00</dateTime>
      <dateTimeWithTimeZone />
      <city>sample string 3</city>
      <state>sample string 4</state>
      <country>sample string 5</country>
      <zip>sample string 6</zip>
      <carrierStatusCode>sample string 7</carrierStatusCode>
      <carrierStatusDesc>sample string 8</carrierStatusDesc>
    </TrackingDetailV3>
  </trackingDetails>
</TrackingResponseV3>