Skip to content
Full API Reference/
/
Get tracking information

ShipEngine API (1.1.202604070904)

ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices.

Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://www.shipengine.com/contact/
ShipEngine Sales & Support
sales@shipengine.com
License
Proprietary
Terms of Service
Languages
Servers
Mock server
https://docs.shipstation.com/_mock/apis/shipengine/openapi/
https://api.shipengine.com/

Account

For additional information about the ShipEngine account.

Operations

Addresses

No matter your shipping volume, failed deliveries and address change surcharges cut into your bottom line and damage perception with customers. Our address validation services ensure your packages make it to the right place the first time. Learn how to leverage our address validation services here.

ShipEngine supports address validation for virtually every country on Earth, including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.

Operations

Batches

batches

Operations

Carrier Accounts

A carrier account is a connection to a shipping carrier that allows you to create labels, track packages, and more. You can connect your own carrier accounts to ShipEngine, or use one of our built-in carrier accounts. Learn more about carrier accounts here.

Operations

Carriers

carriers

Operations

Downloads

downloads

Operations

Insurance

insurance

Operations

Labels

Print shipping labels for any of the top global carriers in minutes—instead of weeks. Simply connect your existing carrier accounts in the API dashboard, and then begin creating labels.

Operations

LTL Shipping

Less-than-truckload (LTL) shipping API endpoints for managing freight shipments. Connect LTL carriers, request quotes, schedule pickups, and track freight shipments.

Operations

Manifests

manifests

Operations

Package Pickups

Scheduled package pickups

Operations

Package Types

custom package types

Operations

Rates

Make sure you ship as cost-effectively as possible by quickly comparing rates using the ShipEngine Rates API. As long as you have the carrier connected to your account, you'll be able to see and compare different rates and services.

Operations

Service Points

Service points allow customers to pick up their packages at convenient locations.

Operations

Shipments

Shipments are at the center of the ShipEngine API. A shipment is the first step in creating a shipping label, or creating a manifest. It's also essential for getting shipping rates.

Operations

Tags

tags

Operations

Tokens

Manage authentication tokens for secure API access.

Operations

Tracking

Track packages across any of our 20+ supported carrier accounts and create tracking events to keep your customers up-to-date. Easily integrate real-time tracking information for shipments into your app, email, or SMS.

Operations

Get tracking information

Request

Retrieve package tracking information

Security
api_key
Query
carrier_codestringnon-empty

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

Example: carrier_code=stamps_com
tracking_numberstringnon-empty

The tracking number associated with a shipment

Example: tracking_number=9405511899223197428490
carrier_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$

Carrier ID

Example: carrier_id=se-28529731
curl -i -X GET \
  'https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/tracking?carrier_code=stamps_com&tracking_number=9405511899223197428490&carrier_id=se-28529731' \
  -H 'API-Key: YOUR_API_KEY_HERE'

Responses

The request was a success.

Bodyapplication/json
tracking_numberstring(tracking_number)non-emptyrequired

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

Example: "1Z932R800392060079"
tracking_urlstringread-onlyrequired

Carrier Tracking Url, if available

Example: "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234"
status_codestring(status_code)read-onlyrequired

The tracking status codes

ValueDescription
UNUnknown
ACAccepted
ITIn Transit
DEDelivered
EXException
ATDelivery Attempt
NYNot Yet In System
SPDelivered To Collection Location
Enum"UN""AC""IT""DE""EX""AT""NY""SP"
Example: "DE"
status_detail_codestring(status_detail_code)read-only

The tracking status detail codes

ValueDescription
CARRIER_STATUS_NOT_MAPPEDStatus not mapped. Please check the carrier's website for updates.
SHIPMENT_CREATEDYour tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.
AWAITING_PICKUP_DROP_OFFYour parcel is waiting to be handed over to the carrier.
DROPPED_OFFYour parcel has been dropped off and is ready for carrier processing.
ELEC_ADVICE_RECD_BY_CARRIERYour shipment is now in the carrier's system.
PICKED_UPYour parcel has been picked up by the carrier.
CUSTOMS_CLEAREDYour parcel has cleared customs and is continuing its journey.
CUSTOMS_PROCESSINGYour parcel is currently being processed by customs.
DELIVERY_ARRANGED_WITH_RECIPIENTYour parcel's delivery has been arranged with the carrier.
HUB_SCAN_OUTYour parcel has left the carrier's hub.
HUB_SCAN_INYour parcel has arrived at the carrier's hub for processing.
IN_TRANSITYour shipment is on its way between the carrier hubs.
INFORMATIONThe carrier has shared additional information about your parcel.
PARCEL_OVER_LABELLEDYour parcel's label has been updated by the carrier, which may affect tracking visibility.
PARCEL_UPDATE_NOTIFICATIONThe carrier has sent you an update on your parcel status via SMS or email.
RECEIVED_BY_CARRIERYour parcel has been received by the carrier and is beginning its journey.
RECEIVED_LOCAL_DELIVERY_DEPOTYour parcel has arrived at the local delivery depot and is almost ready for delivery.
SUB_CONTRACTOR_EVENTThe carrier has shared additional information about your parcel's handling by a delivery partner.
SUB_CONTRACTOR_RECEIVEDYour parcel has been received by the carrier's local delivery partner.
PARCEL_REDIRECTEDYour parcel has been redirected to a new delivery address per your request.
DELIVERY_SCHEDULEDYour parcel's delivery has been scheduled and will soon be out for delivery.
HUB_PROCESSINGYour parcel is being processed at a carrier hub.
DELIVERY_RESCHEDULEDYour parcel's delivery has been rescheduled due to operational issues.
ATTEMPTED_DELIVERYThe carrier attempted to deliver your parcel but was unable to complete delivery.
ATTEMPTED_DELIVERY_FINALThe carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.
COD_AMOUNT_PAIDCash on delivery payment received.
CUSTOMER_CARDEDDelivery attempt failed. Please follow delivery instructions left by the carrier.
OUT_FOR_DELIVERYYour parcel is on its way and will be delivered today.
AWAITING_COLLECTION_FROM_PICKUP_POINTYour parcel is ready for collection at the selected pickup point.
COLLECT_AT_LOCAL_POYour parcel is ready for collection at your local post office.
CUSTOMER_TO_COLLECT_FROM_CARRIERYour parcel is available for collection from the carrier's local delivery unit.
DELIVERED_TO_RECEPTIONYour parcel has been delivered to your building's reception or designated mail area.
DELIVEREDYour parcel has been successfully delivered.
DELIVERED_DAMAGEDYour parcel was delivered but arrived with visible damage.
DELIVERED_IN_PARTPart of your shipment has been delivered. Check for updates on the rest.
DELIVERED_SPECIFIED_SAFE_PLACEYour parcel has been delivered to your specified safe place.
DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATIONYour parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.
DELIVERED_TO_NEIGHBOURYour parcel was delivered to your neighbor.
DELIVERED_TO_PO_BOXYour parcel has been delivered to your specified PO Box.
PARCEL_COLLECTED_FROM_PICKUP_POINTYour package has been picked up from the pick up point.
POST_TRANSIT_STATUSThe carrier has added more information about your delivery.
PROOF_OF_DELIVERYThe carrier has confirmed delivery with proof, such as a signature or photo.
PICKUP_FAILEDParcel pickup failed. The delivery company will try again soon.
NOT_YET_RECEIVED_BY_CARRIERThe carrier has not yet received your parcel, which may cause a delay.
PARCEL_DAMAGEDYour parcel was damaged in transit but will still be delivered.
ADDRESS_QUERYThere is an issue with the delivery address, which may delay your parcel.
CARRIER_DELAYSYour parcel is delayed due to issues within the carrier network.
DELAYED_NOT_CARRIERYour parcel is delayed due to circumstances beyond the carrier's control.
HELD_BY_CARRIERYour parcel is being held due to an operational issue. Contact with the carrier for more information.
HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSINGYour parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.
HELD_BY_CUSTOMSYour parcel is being held at customs, which may delay delivery.
INCORRECT_DECLARATIONYour parcel has been incorrectly declared but is still moving forward for delivery.
MISROUTEDYour parcel was sent to the wrong place due to a routing error but is being redirected.
PARCEL_REPACKEDYour parcel was repackaged by the carrier due to damage and will still be delivered.
RECD_BY_CARRIER_NO_ELEC_ADVICEYour parcel has been received by the carrier but may experience delays due to missing pre-advice.
COD_AMOUNT_NOT_PAIDDelivery failed due to unpaid cash on delivery. Please follow carrier instructions.
CUSTOMER_IDENTIFICATION_FAILEDDelivery couldn't be completed as identification requirements were not met.
NO_ACCESS_TO_RECIPIENTS_ADDRESSThe carrier couldn't access the delivery location due to restricted entry.
CANCELLEDYour parcel has been cancelled.
CUSTOMER_MOVEDDelivery failed as the recipient is no longer at the specified address. Your parcel is being returned.
HAZARDOUS_PROHIBITEDYour parcel contains restricted items and will not be delivered.
NOT_COLLECTED_FROM_PICKUP_POINTYour parcel was not collected from the pickup point within the designated time and will be returned.
NOT_DELIVEREDAll delivery attempts failed. Your parcel is being returned to the sender.
NOT_DELIVERED_ADDRESSEE_DECEASEDThe parcel could not be delivered as the addressee is reported deceased.
PARCEL_DISPOSEDYour parcel has been disposed of due to its contents or condition and will not be delivered.
PARCEL_LOSTThe carrier has reported that your parcel is lost and will not be delivered.
PARCEL_OUTSIDE_OF_SERVICE_CAPABILITYThe parcel cannot be delivered as it exceeds the carrier's service limits.
REFUSED_BY_CUSTOMERYou have refused the parcel, and it will be returned to the sender.
RETURN_TO_SENDERYour parcel is being returned to the sender due to delivery issues.
UNSPECIFIED_EXCEPTIONThe carrier has reported an issue with your parcel, but details are unavailable.
TRACKING_EXPIREDTracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.
DUTY_NOT_PAIDThe import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.
PARCEL_REDIRECTED_BY_CARRIERThe carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.
DELIVERED_TO_PICKUP_POINTYour package has been delivered to the pickup point. You will be notified when its ready for collection.
UNDELIVERABLE_RETURNED_TO_SENDERThe shipment has been returned to the sender. Please contact the sender for further information.
Enum"CARRIER_STATUS_NOT_MAPPED""SHIPMENT_CREATED""AWAITING_PICKUP_DROP_OFF""DROPPED_OFF""ELEC_ADVICE_RECD_BY_CARRIER""PICKED_UP""CUSTOMS_CLEARED""CUSTOMS_PROCESSING""DELIVERY_ARRANGED_WITH_RECIPIENT""HUB_SCAN_OUT"
Example: "DELIVERED"
carrier_codestring(carrier_code)^[a-z0-9]+(_[a-z0-9]+)*$required

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

Example: "dhl_express"
carrier_idinteger(int32)read-onlyrequired

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

status_descriptionstring>= 0 charactersread-only

Status description

Example: "Delivered"
status_detail_descriptionstring>= 0 charactersread-only

Status detail description

Example: "Your parcel has been successfully delivered."
carrier_status_codestringnon-emptyread-onlyrequired

Carrier status code

Example: "1"
carrier_detail_codestringnon-emptyread-onlyrequired

Carrier detail code

Example: "OT"
carrier_status_descriptionstring>= 0 charactersread-only

carrier status description

Example: "Your item was delivered in or at the mailbox at 9:10 am on March"
ship_datestring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...

An ISO 8601 string that represents a date and time.

Example: "2018-09-23T15:00:00.000Z"
estimated_delivery_datestring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...

An ISO 8601 string that represents a date and time.

Example: "2018-09-23T15:00:00.000Z"
actual_delivery_datestring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...

An ISO 8601 string that represents a date and time.

Example: "2018-09-23T15:00:00.000Z"
exception_descriptionstring>= 0 charactersread-only

Exception description

eventsArray of objects(track_event)read-onlyrequired

The events that have occured during the lifetime of this tracking number.

events[].​occurred_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...required

An ISO 8601 string that represents a date and time.

Example: "2018-09-23T15:00:00.000Z"
events[].​carrier_occurred_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...

An ISO 8601 string that represents a date and time.

Example: "2018-09-23T15:00:00.000Z"
events[].​descriptionstring>= 0 charactersread-only

Event description

Example: "Delivered, In/At Mailbox"
events[].​city_localitystring>= 0 charactersread-onlyrequired

City locality

Example: "AUSTIN"
events[].​state_provincestring>= 2 charactersread-onlyrequired

State province

Example: "TX"
events[].​postal_codestring>= 0 charactersread-onlyrequired

Postal code

Example: "78756"
events[].​country_codestring(country_code)= 2 characters

A two-letter ISO 3166-1 country code

Example: "CA"
events[].​company_namestring>= 0 charactersread-only

Company Name

Example: "Stamps.com"
events[].​signerstring>= 0 charactersread-only

Signer information

events[].​event_codestring>= 0 characters

Event Code

events[].​carrier_detail_codestringnon-emptyread-onlyrequired

Carrier detail code

Example: "OT"
events[].​status_codestring(status_code)read-onlyrequired

The tracking status codes

ValueDescription
UNUnknown
ACAccepted
ITIn Transit
DEDelivered
EXException
ATDelivery Attempt
NYNot Yet In System
SPDelivered To Collection Location
Enum"UN""AC""IT""DE""EX""AT""NY""SP"
Example: "IT"
events[].​status_detail_codestring(status_detail_code)read-only

The tracking status detail codes

ValueDescription
CARRIER_STATUS_NOT_MAPPEDStatus not mapped. Please check the carrier's website for updates.
SHIPMENT_CREATEDYour tracking number is ready. Your parcel is waiting to be registered in the carrier system and scheduled for pickup.
AWAITING_PICKUP_DROP_OFFYour parcel is waiting to be handed over to the carrier.
DROPPED_OFFYour parcel has been dropped off and is ready for carrier processing.
ELEC_ADVICE_RECD_BY_CARRIERYour shipment is now in the carrier's system.
PICKED_UPYour parcel has been picked up by the carrier.
CUSTOMS_CLEAREDYour parcel has cleared customs and is continuing its journey.
CUSTOMS_PROCESSINGYour parcel is currently being processed by customs.
DELIVERY_ARRANGED_WITH_RECIPIENTYour parcel's delivery has been arranged with the carrier.
HUB_SCAN_OUTYour parcel has left the carrier's hub.
HUB_SCAN_INYour parcel has arrived at the carrier's hub for processing.
IN_TRANSITYour shipment is on its way between the carrier hubs.
INFORMATIONThe carrier has shared additional information about your parcel.
PARCEL_OVER_LABELLEDYour parcel's label has been updated by the carrier, which may affect tracking visibility.
PARCEL_UPDATE_NOTIFICATIONThe carrier has sent you an update on your parcel status via SMS or email.
RECEIVED_BY_CARRIERYour parcel has been received by the carrier and is beginning its journey.
RECEIVED_LOCAL_DELIVERY_DEPOTYour parcel has arrived at the local delivery depot and is almost ready for delivery.
SUB_CONTRACTOR_EVENTThe carrier has shared additional information about your parcel's handling by a delivery partner.
SUB_CONTRACTOR_RECEIVEDYour parcel has been received by the carrier's local delivery partner.
PARCEL_REDIRECTEDYour parcel has been redirected to a new delivery address per your request.
DELIVERY_SCHEDULEDYour parcel's delivery has been scheduled and will soon be out for delivery.
HUB_PROCESSINGYour parcel is being processed at a carrier hub.
DELIVERY_RESCHEDULEDYour parcel's delivery has been rescheduled due to operational issues.
ATTEMPTED_DELIVERYThe carrier attempted to deliver your parcel but was unable to complete delivery.
ATTEMPTED_DELIVERY_FINALThe carrier made a final attempt to deliver your parcel but was unable to complete delivery. Please check the carrier's instructions for next steps.
COD_AMOUNT_PAIDCash on delivery payment received.
CUSTOMER_CARDEDDelivery attempt failed. Please follow delivery instructions left by the carrier.
OUT_FOR_DELIVERYYour parcel is on its way and will be delivered today.
AWAITING_COLLECTION_FROM_PICKUP_POINTYour parcel is ready for collection at the selected pickup point.
COLLECT_AT_LOCAL_POYour parcel is ready for collection at your local post office.
CUSTOMER_TO_COLLECT_FROM_CARRIERYour parcel is available for collection from the carrier's local delivery unit.
DELIVERED_TO_RECEPTIONYour parcel has been delivered to your building's reception or designated mail area.
DELIVEREDYour parcel has been successfully delivered.
DELIVERED_DAMAGEDYour parcel was delivered but arrived with visible damage.
DELIVERED_IN_PARTPart of your shipment has been delivered. Check for updates on the rest.
DELIVERED_SPECIFIED_SAFE_PLACEYour parcel has been delivered to your specified safe place.
DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATIONYour parcel was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details.
DELIVERED_TO_NEIGHBOURYour parcel was delivered to your neighbor.
DELIVERED_TO_PO_BOXYour parcel has been delivered to your specified PO Box.
PARCEL_COLLECTED_FROM_PICKUP_POINTYour package has been picked up from the pick up point.
POST_TRANSIT_STATUSThe carrier has added more information about your delivery.
PROOF_OF_DELIVERYThe carrier has confirmed delivery with proof, such as a signature or photo.
PICKUP_FAILEDParcel pickup failed. The delivery company will try again soon.
NOT_YET_RECEIVED_BY_CARRIERThe carrier has not yet received your parcel, which may cause a delay.
PARCEL_DAMAGEDYour parcel was damaged in transit but will still be delivered.
ADDRESS_QUERYThere is an issue with the delivery address, which may delay your parcel.
CARRIER_DELAYSYour parcel is delayed due to issues within the carrier network.
DELAYED_NOT_CARRIERYour parcel is delayed due to circumstances beyond the carrier's control.
HELD_BY_CARRIERYour parcel is being held due to an operational issue. Contact with the carrier for more information.
HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSINGYour parcel is being held by the carrier for customs documentation checks. This may occur when the carrier must confirm documentation before the parcel can continue its journey.
HELD_BY_CUSTOMSYour parcel is being held at customs, which may delay delivery.
INCORRECT_DECLARATIONYour parcel has been incorrectly declared but is still moving forward for delivery.
MISROUTEDYour parcel was sent to the wrong place due to a routing error but is being redirected.
PARCEL_REPACKEDYour parcel was repackaged by the carrier due to damage and will still be delivered.
RECD_BY_CARRIER_NO_ELEC_ADVICEYour parcel has been received by the carrier but may experience delays due to missing pre-advice.
COD_AMOUNT_NOT_PAIDDelivery failed due to unpaid cash on delivery. Please follow carrier instructions.
CUSTOMER_IDENTIFICATION_FAILEDDelivery couldn't be completed as identification requirements were not met.
NO_ACCESS_TO_RECIPIENTS_ADDRESSThe carrier couldn't access the delivery location due to restricted entry.
CANCELLEDYour parcel has been cancelled.
CUSTOMER_MOVEDDelivery failed as the recipient is no longer at the specified address. Your parcel is being returned.
HAZARDOUS_PROHIBITEDYour parcel contains restricted items and will not be delivered.
NOT_COLLECTED_FROM_PICKUP_POINTYour parcel was not collected from the pickup point within the designated time and will be returned.
NOT_DELIVEREDAll delivery attempts failed. Your parcel is being returned to the sender.
NOT_DELIVERED_ADDRESSEE_DECEASEDThe parcel could not be delivered as the addressee is reported deceased.
PARCEL_DISPOSEDYour parcel has been disposed of due to its contents or condition and will not be delivered.
PARCEL_LOSTThe carrier has reported that your parcel is lost and will not be delivered.
PARCEL_OUTSIDE_OF_SERVICE_CAPABILITYThe parcel cannot be delivered as it exceeds the carrier's service limits.
REFUSED_BY_CUSTOMERYou have refused the parcel, and it will be returned to the sender.
RETURN_TO_SENDERYour parcel is being returned to the sender due to delivery issues.
UNSPECIFIED_EXCEPTIONThe carrier has reported an issue with your parcel, but details are unavailable.
TRACKING_EXPIREDTracking for this parcel has expired. If you are still expecting this delivery, please contact the carrier for assistance.
DUTY_NOT_PAIDThe import taxes or duties for this package havent been paid and it may be subject to disposal by customs authorities if payment is not made.
PARCEL_REDIRECTED_BY_CARRIERThe carrier has redirected your parcel due to an operational issue. The package is likely being rerouted to a nearby pickup point. You may contact the carrier for more details about the new delivery location.
DELIVERED_TO_PICKUP_POINTYour package has been delivered to the pickup point. You will be notified when its ready for collection.
UNDELIVERABLE_RETURNED_TO_SENDERThe shipment has been returned to the sender. Please contact the sender for further information.
Enum"CARRIER_STATUS_NOT_MAPPED""SHIPMENT_CREATED""AWAITING_PICKUP_DROP_OFF""DROPPED_OFF""ELEC_ADVICE_RECD_BY_CARRIER""PICKED_UP""CUSTOMS_CLEARED""CUSTOMS_PROCESSING""DELIVERY_ARRANGED_WITH_RECIPIENT""HUB_SCAN_OUT"
Example: "IN_TRANSIT"
events[].​status_descriptionstringnon-emptyread-onlyrequired

Event Status Description

Example: "In Transit"
events[].​status_detail_descriptionstring>= 0 charactersread-only

Event Status Detail Description

Example: "Your shipment is on its way between the carrier hubs."
events[].​carrier_status_codestringnon-emptyread-onlyrequired

Carrier status code

Example: "1"
events[].​carrier_status_descriptionstring>= 0 charactersread-onlyrequired

carrier status description

Example: "Your item was delivered in or at the mailbox at 9:10 am on March"
events[].​latitudenumber(double)[ -90 .. 90 ]

Latitude coordinate of tracking event.

events[].​longitudenumber(double)[ -180 .. 180 ]

Longitude coordinate of tracking event.

events[].​proof_of_delivery_urlstringread-only

A URL to an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc.

Example: "https://tracking-service-prod.s3.amazonaws.com/proof-of-delivery/dummy_module/0000000001/bc6dd17969bd97f24262ca73ac6ff36062aafecba25ef16d4178264bf7c0e72c.png"
Response
application/json
{
  "tracking_number": "1Z932R800392060079",
  "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234",
  "status_code": "DE",
  "status_detail_code": "DELIVERED",
  "carrier_code": "dhl_express",
  "carrier_id": 0,
  "status_description": "Delivered",
  "status_detail_description": "Your parcel has been successfully delivered.",
  "carrier_status_code": "1",
  "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",
  "exception_description": "string",
  "events": [
    { … }
  ]
}

Start tracking a package

Request

Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes.

Security
api_key
Query
carrier_codestringnon-empty

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

Example: carrier_code=stamps_com
tracking_numberstringnon-empty

The tracking number associated with a shipment

Example: tracking_number=9405511899223197428490
carrier_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$

Carrier ID

Example: carrier_id=se-28529731
curl -i -X POST \
  'https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/tracking/start?carrier_code=stamps_com&tracking_number=9405511899223197428490&carrier_id=se-28529731' \
  -H 'API-Key: YOUR_API_KEY_HERE'

Responses

The request was successful.

Body
string(empty_response_body)= 0 characters
Response
No response example

Stop tracking a package

Request

Unsubscribe from tracking updates for a package.

Security
api_key
Query
carrier_codestringnon-empty

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

Example: carrier_code=stamps_com
tracking_numberstringnon-empty

The tracking number associated with a shipment

Example: tracking_number=9405511899223197428490
carrier_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$

Carrier ID

Example: carrier_id=se-28529731
curl -i -X POST \
  'https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/tracking/stop?carrier_code=stamps_com&tracking_number=9405511899223197428490&carrier_id=se-28529731' \
  -H 'API-Key: YOUR_API_KEY_HERE'

Responses

The request was successful.

Body
string(empty_response_body)= 0 characters
Response
No response example

Warehouses

warehouses

Operations

Webhooks

Webhooks are a powerful feature of ShipEngine that can save you from sending repeated polling requests to check on the state of something. With webhooks, ShipEngine will automatically contact your servers when the state changes. This can include parcel tracking events, notification of the completion of a batch operation, or new sales orders.

Operations
Shipstation
  • Facebook
  • Linkedin
  • Instagram
Auctane
ShipStation is powered by Auctane, a global delivery experience company. © 2026 Auctane, Inc. All rights reserved