Start Tracking Updates

POST /v1/tracking/start

This endpoint allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and we'll notify you whenever the shipping status changes.

You can unsubscribe from updates at any time by stopping tracking updates.

Warning

Setup Web Hooks First

You need to set up web hooks first, so we know how to contact you when the shipping status changes.

Example

The following example demonstrates how to start tracking a package. You need to specify the carrier_code (see this table) and the tracking_number of the package.

If successful, ShipEngine will respond with an HTTP Status Code of 204 (No Content)

curl -iX POST https://api.shipengine.com/v1/tracking/start?carrier_code=stamps_com&tracking_number=9361269903502070406152 \
-H 'Content-Type: application/json' \
-H 'API-Key: __YOUR_API_KEY_HERE__'
POST /v1/tracking/start?carrier_code=stamps_com&tracking_number=9361269903502070406152 HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Cache-Control: no-cache
Content-Type: application/json
  • curl
  • http