INintersoftsapient
Trackings

Tracking Webhook Push Payload Example

Changed on

This API endpoint is an example of the tracking webhook push notification payload, as sent to a customer's webhook when tracking information is received from a carrier. <br /> <br />If the shipment has not been created in SAPIENT or IShipper, then use the Trackings API to register the shipment first in order to receive the tracking data via the tracking webhook. <br /> <br />Note: This is an example of the payload SAPIENT posts to the customer. It is not a functioning API endpoint.

post/v4/trackings/PushPayloadExample

Request

  • Base URL
    https://api.intersoftsapient.net
  • URL
    https://api.intersoftsapient.net/v4/trackings/PushPayloadExample
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://authentication.intersoftsapient.net/connect/token

Request body

TrackingNumberstring required

The tracking number assigned to the shipment by the carrier. This number is used to monitor the shipment's progress and location in transit.

ShipmentIdstring uuid required

A unique identifier for each shipment as returned from the Create Shipment or Trackings API endpoint. This ID is used to reference and track specific shipments within the system.

ShipperReferencestring

The shipper's reference for this shipment. This is usually the shipper's order number that is provided to the receiver when the shipment was created.

CarrierCodestring required

A unique identifier for the carrier associated with the shipping account. This code is alphanumeric and helps in identifying the specific carrier.

Milestonestring

A sequence of stages within the shipment process that are essential for monitoring progress, such as collected, label printed, out for delivery, and so on. <br /> <br />This can be an empty string if no milestone corresponds to the tracking event, or it may indicate a significant event that has occurred during shipment, such as the following: <br /> <br />• COLLECTED <br />• DELIVERED <br />• DELIVERY ATTEMPT FAILED <br />• IN CUSTOMS <br />• IN TRANSIT <br />• IT'S ON ITS WAY <br />• OUT FOR DELIVERY <br />• PART DELIVERED <br />• READY FOR COLLECTION <br />• TRANSIT DELAY <br />• UNDELIVERABLE

MilestoneDateTimestring

The date and time at which the milestone event occurred. This is crucial for understanding the timeline of the shipment's journey. <br /> <br />Note: The milestone date and time will be in the YYYY-MM-DD HH:MM:SS format.

Response

Success

Changes