tracking_number.
This endpoint works for:
- Parcels created via Sendcloud shipments
- External parcels registered for tracking via the Create an external parcel for tracking endpoint
Calling the endpoint
To retrieve tracking information, send aGET request including the tracking number in the path:
Example request method and URL
Response
If successful, the API returns:- HTTP 200 status code
- A Parcel Tracking object containing:
- Parcel lifecycle timestamps:
created_at— When the parcel tracking object was created in Sendcloudannounced_at— When the parcel was handed to the carrierupdated_at— Last time tracking information was updated
details: Additional context such asexpected_delivery_date,integration_id, service point indicators, return flagstracking_numbers: Carrier tracking identifiers associated with the parcel.events: A chronological list of tracking events representing delivery milestones.parent_status: carrier status messages standardized into a consistent Sendcloud status. This allows you to reliably interpret the parcel’s delivery state across different carriers.
- Parcel lifecycle timestamps:
tracking number is invalid or unknown, the API returns an error response instead of a parcel object.
See the API reference for the full response
schema.
Status definitions
Sendcloud consolidates all the variations of status messages received by different carriers into a readable format. This corresponds with theparent_status field in the response.
Real-time event notifications
Instead of polling this endpoint for status changes, you can receive push notifications whenever parcel events occur. The Event Subscriptions API lets you configure webhooks or third-party integrations to be notified automatically.The Event Subscriptions API is currently in BETA.