Sign in
latestOpenAPI 3.1.0MIT2026-08-221643491.4 MB

d3d8c21cd227

labels

Get label tracking information

<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>

Retrieve the label's tracking details.

get/v2/labels/{label_id}/track

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' | 'SP'

The high-level tracking status codes

ValueDescription
UNUnknown
ACAccepted
ITIn Transit
DEDelivered
EXException
ATDelivery Attempt
NYNot Yet In System
SPDelivered To Collection Location
status_detail_code'COLLECTION_FAILED' | 'AWAITING_DESPATCH' | 'COLLECTION_REQUESTED' | 'DESPATCHED' | 'ELEC_ADVICE_RECD_BY_CARRIER' | 'NOT_YET_RECEIVED_BY_CARRIER' | 'COLLECTION_MADE' | 'ATTEMPTED_DELIVERY' | 'ATTEMPTED_DELIVERY_2ND' | 'ATTEMPTED_DELIVERY_3RD' | 'COD_AMOUNT_NOT_PAID' | 'COD_AMOUNT_PAID' | 'CUSTOMER_CARDED' | 'CUSTOMER_IDENTIFICATION_FAILED' | 'INVALID_METHOD_OF_PAYMENT' | 'NO_ACCESS_TO_RECIPIENTS_ADDRESS' | 'OUT_FOR_DELIVERY' | 'DELIVERED' | 'DELIVERED_DAMAGED' | 'DELIVERED_IN_PART' | 'DELIVERED_SPECIFIED_SAFE_PLACE' | 'DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION' | 'DELIVERED_TO_NEIGHBOUR' | 'DELIVERED_TO_PO_BOX' | 'PARCEL_COLLECTED_FROM_PICKUP_POINT' | 'POST_TRANSIT_STATUS' | 'PROOF_OF_DELIVERY' | 'CANCELLED' | 'CANCELLED_BEFORE_DESPATCH' | 'CUSTOMER_MOVED' | 'HAZARDOUS_PROHIBITED' | 'NOT_COLLECTED_FROM_PICKUP_POINT' | 'NOT_DELIVERED' | 'NOT_DELIVERED_ADDRESSEE_DECEASED' | 'PARCEL_DAMAGED' | 'PARCEL_DISPOSED' | 'PARCEL_LOST' | 'PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY' | 'REFUSED_BY_CUSTOMER' | 'RETURN_TO_SENDER' | 'ADDRESS_QUERY' | 'CARRIER_DELAYS' | 'CUSTOMS_CLEARED' | 'CUSTOMS_PROCESSING' | 'DELAYED_NOT_CARRIER' | 'DELIVERY_ARRANGED_WITH_RECIPIENT' | 'HELD_BY_CARRIER' | 'HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING' | 'HELD_BY_CUSTOMS' | 'HELD_BY_EXPORT_CUSTOMS' | 'HELD_BY_IMPORT_CUSTOMS' | 'HUB_SCAN_OUT' | 'IN_TRANSIT' | 'INCORRECT_DECLARATION' | 'INFORMATION' | 'MISSORTED' | 'PARCEL_OVER_LABELLED' | 'PARCEL_REPACKED' | 'PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL' | 'PARCEL_UPDATE_NOTIFICATION_VIA_SMS' | 'RECEIVED_BY_CARRIER' | 'RECEIVED_LOCAL_DELIVERY_DEPOT' | 'ROUTING_ERROR' | 'SUB_CONTRACTOR_EVENT' | 'SUB_CONTRACTOR_RECEIVED' | 'RECD_BY_CARRIER_NO_ELEC_ADVICE' | 'AWAITING_ELECTRONIC_ADVICE' | 'AWAITING_COLLECTION_FROM_PICKUP_POINT' | 'COLLECT_AT_LOCAL_PO' | 'CUSTOMER_TO_COLLECT_FROM_CARRIER' | 'DELIVERED_TO_LOCKER_COLLECTION_POINT' | 'CARRIER_STATUS_NOT_MAPPED'

The tracking status detail codes

ValueDescription
COLLECTION_FAILEDShipment pickup failed. The delivery company will try again soon.
AWAITING_DESPATCHYour shipment is ready to go and is waiting for pickup.
COLLECTION_REQUESTEDYour shipment pickup has been scheduled.
DESPATCHEDYour shipment has been handed over to the carrier or dropped off at collection point. It will soon start its journey.
ELEC_ADVICE_RECD_BY_CARRIERYour shipment is now in the carrier's system.
NOT_YET_RECEIVED_BY_CARRIERThe sender couldn't hand over your shipment. The delivery company will try to collect it again.
COLLECTION_MADEYour shipment has been picked up by the carrier.
ATTEMPTED_DELIVERYDelivery attempt failed. Please check the carrier's instructions for next steps.
ATTEMPTED_DELIVERY_2NDSecond delivery attempt failed. Please check the carrier's instructions for next steps.
ATTEMPTED_DELIVERY_3RDThird delivery attempt failed. Please check the carrier's instructions for next steps.
COD_AMOUNT_NOT_PAIDDelivery failed due to unpaid cash on delivery. Please check carrier instructions.
COD_AMOUNT_PAIDCash on delivery payment received.
CUSTOMER_CARDEDDelivery attempt failed. Please check for delivery instructions left by the carrier.
CUSTOMER_IDENTIFICATION_FAILEDThere was a recipient identification issue. Please check carrier instructions.
INVALID_METHOD_OF_PAYMENTDelivery failed due to incorrect payment. Please check carrier instructions.
NO_ACCESS_TO_RECIPIENTS_ADDRESSDelivery couldn't be completed due to issues with accessing address. Please follow carrier instructions.
OUT_FOR_DELIVERYYour shipment is out for delivery.
DELIVEREDYour shipment has been delivered.
DELIVERED_DAMAGEDYour shipment was delivered but arrived damaged.
DELIVERED_IN_PARTPart of your shipment has been delivered. Check for updates on the rest.
DELIVERED_SPECIFIED_SAFE_PLACEYour shipment has been left in your designated safe place.
DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATIONYour shipment 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 shipment was delivered to your neighbor.
DELIVERED_TO_PO_BOXYour shipment was delivered to your PO Box.
PARCEL_COLLECTED_FROM_PICKUP_POINTYour package has been picked up from the collection point.
POST_TRANSIT_STATUSThe carrier has added more information about your delivery.
PROOF_OF_DELIVERYDelivery confirmed.
CANCELLEDYour shipment has been cancelled.
CANCELLED_BEFORE_DESPATCHYour shipment was cancelled before pickup. Contact the sender if unexpected.
CUSTOMER_MOVEDRecipient not at address. Your shipment is being returned.
HAZARDOUS_PROHIBITEDYour parcel contained a prohibited item and is being returned. Contact the sender.
NOT_COLLECTED_FROM_PICKUP_POINTShipment not collected from the pickup point. Your parcel is being returned to the sender.
NOT_DELIVEREDDelivery attempts failed. Your parcel is being returned to the sender.
NOT_DELIVERED_ADDRESSEE_DECEASEDDelivery not possible due to recipient's passing.
PARCEL_DAMAGEDYour parcel was damaged and can't be delivered. It's being returned. Contact the sender.
PARCEL_DISPOSEDShipment was disposed of. Contact the sender for details.
PARCEL_LOSTYour parcel is lost. Contact the sender for next steps.
PARCEL_OUTSIDE_OF_SERVICE_CAPABILITYShipment is too large/heavy for delivery. Being returned. Contact sender.
REFUSED_BY_CUSTOMERDelivery refused. Shipment being returned. Contact the sender.
RETURN_TO_SENDERYour shipment is being returned to the sender. Contact them for details.
ADDRESS_QUERYThere's an issue with your delivery address. This may cause a delay or return. Contact sender or carrier.
CARRIER_DELAYSThere's a delivery delay. We'll update you when there's more info.
CUSTOMS_CLEAREDYour shipment has passed customs clearance.
CUSTOMS_PROCESSINGYour shipment is going through customs.
DELAYED_NOT_CARRIERUnexpected delivery delay. We'll update you soon.
DELIVERY_ARRANGED_WITH_RECIPIENTDelivery arranged by recipient.
HELD_BY_CARRIERYour shipment is on hold due to a carrier issue. We'll update you soon.
HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSINGYour shipment is held by carrier due to customs issues. We'll update you.
HELD_BY_CUSTOMSYour shipment is held in customs. We'll update you.
HELD_BY_EXPORT_CUSTOMSYour shipment is held in export customs. We'll update you.
HELD_BY_IMPORT_CUSTOMSYour shipment is held in import customs. We'll update you.
HUB_SCAN_OUTYour shipment is at the main delivery depot.
IN_TRANSITYour shipment is on its way between depots.
INCORRECT_DECLARATIONIncorrect shipment dimensions. Delivery may be delayed or returned. We'll update you.
INFORMATIONThe carrier has shared additional shipment information.
MISSORTEDYour shipment was missorted. There might be a delivery delay. We'll update you.
PARCEL_OVER_LABELLEDYour shipment was over labelled by the delivery company to improve processing.
PARCEL_REPACKEDYour shipment packaging was damaged. It's being repacked. This might delay delivery.
PARCEL_UPDATE_NOTIFICATION_VIA_EMAILYou've received an email with a shipment update.
PARCEL_UPDATE_NOTIFICATION_VIA_SMSYou've received a text message with a shipment update.
RECEIVED_BY_CARRIERYour shipment has been received by the carrier.
RECEIVED_LOCAL_DELIVERY_DEPOTYour shipment is at the local delivery depot, ready for delivery.
ROUTING_ERRORYour shipment was sent to the wrong place. There might be a delay.
SUB_CONTRACTOR_EVENTYour shipment is with the local delivery partner.
SUB_CONTRACTOR_RECEIVEDYour shipment has been received by the local delivery partner.
RECD_BY_CARRIER_NO_ELEC_ADVICEThere's a system issue with your shipment. Tracking updates might be delayed.
AWAITING_ELECTRONIC_ADVICEYour tracking number is ready. Your shipment is waiting to be registered in the carrier system and scheduled for pickup.
AWAITING_COLLECTION_FROM_PICKUP_POINTYour shipment is ready for pickup at the specified location.
COLLECT_AT_LOCAL_POYour shipment has been redirected to the local post office for pickup. Check carrier instructions.
CUSTOMER_TO_COLLECT_FROM_CARRIERYour shipment is being held for pickup. Check carrier instructions.
DELIVERED_TO_LOCKER_COLLECTION_POINTYour shipment has been delivered to your locker.
CARRIER_STATUS_NOT_MAPPEDStatus not mapped. Please check the carrier's website for updates.
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

status_detail_descriptionstring

Status detail 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",
  "carrier_id": 1234567,
  "status_description": "Delivered",
  "status_detail_description": "Your shipment has been 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": "this is exception description",
  "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",
      "postal_code": "78756",
      "country_code": "CA",
      "company_name": "Stamps.com",
      "event_code": "DLD",
      "carrier_detail_code": "OT",
      "status_description": "In Transit",
      "status_detail_description": "Your shipment is on its way between depots.",
      "carrier_status_code": "01",
      "carrier_status_description": "Your item was delivered in or at the mailbox at 9:10 am on March",
      "latitude": 89,
      "longitude": 23,
      "proof_of_delivery_url": "https://tracking-service-prod.s3.amazonaws.com/proof-of-delivery/dummy_module/0000000001/bc6dd17969bd97f24262ca73ac6ff36062aafecba25ef16d4178264bf7c0e72c.png"
    }
  ]
}