INintersoftsapient
Trackings

Trackings

The Trackings API facilitates the integration of the Sapient tracking webhook, enabling customers to receive tracking information for Royal Mail shipments that are not created within the INTERSOFT shipping platform, such as SAPIENT or IShipper. By utilising this endpoint, in a single request, you can register up to 1000 tracking numbers for which you wish to receive updates. Once registered, you can then seamlessly receive tracking data for these numbers through the our tracking webhook, enhancing visibility and efficiency in managing your shipments. <br /> <br />It is essential to note that this endpoint should not be used for Royal Mail shipments created on your own INTERSOFT account. <br /> <br />Note: This is a chargeable service, and you are billed automatically based on the number of shipments tracked using the Trackings API.

post/v4/trackings

Request

  • Base URL
    https://api.intersoftsapient.net
  • URL
    https://api.intersoftsapient.net/v4/trackings
  • 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.

ShipperReferencestring nullable

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

CarrierCodestring required

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

CountryCodestring nullable

An abbreviation representing the country for the shipment, following the ISO 3166-1 alpha-2 standard, for example, "GB" for the United Kingdom.

Postcodestring nullable

The postal or ZIP code corresponding to the shipment's destination, used to identify specific geographic areas.

AccountNumberstring nullable

The number assigned to the shipping account by the carrier, typically used for tracking shipments and billing purposes.

ShippingDatestring date nullable

The date on which the shipment was sent. This information is important for tracking the timeline of delivery and for any time-sensitive shipment inquiries. <br /> <br />Note: This information is required by some carriers. If this date is provided, then it must be in the YYYY-MM-DD format.

ServiceCodestring nullable

The code representing the carrier's shipping service selected for the shipments.

Example request

[
  {
    "AccountNumber": "9912347707"
  }
]

Response

Returns an array of tracking numbers and the shipment ids assigned to them, corresponding to future tracking information.

TrackingNumberstring nullable

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

CarrierCodestring nullable

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

ShipmentIdstring uuid

A unique identifier for each shipment. This ID is used to reference and track specific shipments within the system.

Example response

[
  {
    "TrackingNumber": "TT123456785GB",
    "CarrierCode": "RM",
    "ShipmentId": "c4e60776-288f-464e-b35b-ff0f3252c0f0"
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.