tracking

Get Tracking Information

Retrieve package tracking information

get/v1/tracking

Query parameters

carrier_codestring

A shipping carrier, such as fedex, dhl_express, stamps_com, etc.

tracking_numberstring

The tracking number associated with a shipment

Response

The request was a success.

tracking_numberstring

A tracking number for a package. The format depends on the carrier.

tracking_urlstring

Carrier Tracking Url, if available

status_code'UN' | 'AC' | 'IT' | 'DE' | 'EX' | 'AT' | 'NY'

The tracking status codes

ValueDescription
UNUnknown
ACAccepted
ITIn Transit
DEDelivered
EXException
ATDelivery Attempt
NYNot Yet In System
carrier_codestring

A shipping carrier, such as fedex, dhl_express, stamps_com, etc.

carrier_idinteger

The unique ID of the carrier account that was used to create this label

status_descriptionstring

Status description

carrier_status_codestring

Carrier status code

carrier_detail_codestring

Carrier detail code

carrier_status_descriptionstring

carrier status description

ship_datestring date-time

An ISO 8601 string that represents a date and time.

estimated_delivery_datestring date-time

An ISO 8601 string that represents a date and time.

actual_delivery_datestring date-time

An ISO 8601 string that represents a date and time.

exception_descriptionstring

Exception description

Example response

{
  "tracking_number": "1Z932R800392060079",
  "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234",
  "carrier_code": "dhl_express",
  "status_description": "Delivered",
  "carrier_detail_code": "OT",
  "carrier_status_description": "Your item was delivered in or at the mailbox at 9:10 am on March",
  "ship_date": "2018-09-23T15:00:00.000Z",
  "estimated_delivery_date": "2018-09-23T15:00:00.000Z",
  "actual_delivery_date": "2018-09-23T15:00:00.000Z",
  "events": [
    {
      "occurred_at": "2018-09-23T15:00:00.000Z",
      "carrier_occurred_at": "2018-09-23T15:00:00.000Z",
      "description": "Delivered, In/At Mailbox",
      "city_locality": "AUSTIN",
      "state_province": "TX",
      "country_code": "CA",
      "company_name": "Stamps.com",
      "carrier_detail_code": "OT",
      "status_description": "In Transit",
      "carrier_status_description": "Your item was delivered in or at the mailbox at 9:10 am on March"
    }
  ]
}

Changes