Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Trackings

Tracking Webhook Push Payload Example

Example of the tracking webhook push notification payload, as sent to a customer's webhook when tracking information is received from a carrier. <br />For a webhook push notification to be triggered, the tracking number must be registered with SAPIENT and a tracking account and tracking webhook must be configured. <br /> <br />Note: this is an example of what SAPIENT posts to the customer, it is not a functioning API endpoint.

post/v4/trackings/PushPayloadExample

Request body

TrackingNumberstring required

Tracking Number

ShipmentIdstring uuid required

Shipment Id <br />The shipment identifier as returned from creating shipments or from the trackings API endpoint.

ShipperReferencestring

Shipper Reference <br />The shipper reference, as provided at the time the shipment was created or registered with the trackings API endpoint, or from the tracking event information (if available) if not supplied on shipment creation.

CarrierCodestring required

Carrier Code

Milestonestring

Milestone <br />Either an empty string if the tracking event does not correspond to a milestone and no milestones have been triggered for the shipment, or else one of the following: <br /> <br />- COLLECTED <br />- DELIVERED <br />- DELIVERY ATTEMPT FAILED <br />- IN CUSTOMS <br />- IN TRANSIT <br />- IT'S ON IT'S WAY <br />- OUT FOR DELIVERY <br />- PART DELIVERED <br />- READY FOR COLLECTION <br />- TRANSIT DELAY <br />- UNDELIVERABLE

MilestoneDateTimestring

Milestone Date/Time <br />Either an empty string if the tracking event does not correspond to a milestone and no milestones have been triggered for the shipment, or the milestone date and time. <br />Format: YYYY-MM-DD HH:MM:SS

Response

Success