Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Trackings

Trackings

Note: This is a chargeable service, and you are billed automatically based on the number of shipments tracked using the Trackings API. <br /> <br />The Trackings API is an addition to the standard tracking webhook service, that automatically pushes tracking information for Royal Mail shipments created through Intersoft. This endpoint is intended for registering tracking numbers for shipments produced on other systems or different Intersoft accounts. <br /> <br /> <br />It is essential to note that this endpoint should not be be used for Royal Mail shipments created on your own Intersoft account. The primary function of this endpoint is to monitor tracking events and push the data to the tracking webhook, ensuring effective tracking management.

post/v4/trackings

Request body

TrackingNumberstring required

Tracking Number

ShipperReferencestring nullable

Shipper Reference

CarrierCodestring required

Carrier Code

CountryCodestring nullable

Country Code

Postcodestring nullable

Postcode

AccountNumberstring nullable

Carrier Account Number <br />The account number given by the carrier.

ShippingDatestring date nullable

Shipping Date <br />Shipping date in YYYY-MM-DD format. Required by some couriers. <br />
<br />Accepted Format: YYYY-MM-DD

ServiceCodestring nullable

Service Code

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

Tracking Number as provided in the request

CarrierCodestring nullable

Carrier Code as provided in the request

ShipmentIdstring uuid

Shipment Id generated for the shipment

Example response

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