Skip to main content
POST
cURL

Authorizations

Authorization
string
header
default:ShippoToken
required

API key authentication using the ShippoToken scheme. Format: Authorization: ShippoToken <API_TOKEN> Example: Authorization: ShippoToken shippo_live_abc123

Headers

SHIPPO-API-VERSION
string
default:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

Example:

"2018-02-08"

Body

application/json
carrier
string
required

Name of the carrier of the shipment to track.

Example:

"usps"

tracking_number
string
required

Tracking number to track.

Example:

"9205590164917312751089"

metadata
string

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

Example:

"Order 000123"

Response

Tracking status

carrier
string
required

Name of the carrier of the shipment to track. See Carriers.

Example:

"usps"

messages
string[]
required
tracking_history
object[]
required

A list of tracking events, following the same structure as tracking_status. It contains a full history of all tracking statuses, starting with the earlier tracking event first.

tracking_number
string
required

Tracking number to track.

Example:

"9205590164917312751089"

address_from
object

The sender address with city, state, zip and country information.

address_to
object

The recipient address with city, state, zip and country information.

eta
string<date-time>

The estimated time of arrival according to the carrier, this might be updated by carriers during the life of the shipment.

metadata
string

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

Example:

"Order 000123"

original_eta
string<date-time>

The estimated time of arrival according to the carrier at the time the shipment first entered the system.

Example:

"2021-07-23T00:00:00Z"

servicelevel
object

Contains details regarding the service level for the given rate.

tracking_status
object

The latest tracking information of this shipment.

transaction
string

The object_id of the transaction associated with this tracking object. This field is visible only to the object owner of the transaction.

Last modified on July 16, 2026