post https://sandbox.sendle.com/api/tracking//subscribe
This endpoint allows a user to subscribe to tracking events via webhooks for a specific parcel, identified by its Sendle reference (ref). Once subscribed, the user will receive real-time tracking updates via webhooks to the callback endpoint url on the account.
The initial response to this subscription request will include all existing tracking events associated with the parcel. Webhook events are only sent for updates that occur after the subscription is created.
Note: A webhook endpoint must be registered on the account before a subscription can be created. You can add a callback endpoint url through the account dashboard under Settings --> API.
This feature is currently in beta. To gain access, please contact the Sendle Integration team.
Here's most of our tracking events and what they mean:
| Tracking Event | Description |
|---|---|
| Pickup Attempted | Driver attempted to pickup the parcel. |
| Pickup | Parcel successfully picked up. |
| Drop Off | Parcel has not yet been dropped off. |
| Dropped Off | Parcel left at a drop-off location. |
| Info | Information about the parcel. This can come from us or the delivery partner. |
| In Transit | Parcel in transit between hub locations. |
| Out for Delivery | Driver has the parcel and is taking it to be delivered. |
| Delivery Attempted | Parcel delivery attempted, but unsuccessful. |
| Delivered | Parcel successfully delivered. |
| Local Delivery | Delivery is being handled by a local partner (e.g. a local postal service or similar). |
| Card Left | Parcel delivery attempted and a card has been left for the receiver to arrange collection or re-delivery. |
| Left with Agent | Parcel has been left with a parcel connect location, POPStation, or similar for collection. |
| Damaged | Parcel has been marked as damaged. |
| Unable to Deliver | Parcel could not be delivered. |
| Expired | The label for this parcel has expired. |
If you receive an event type not on this list, look at the description of the event for more information.