Tracking API Guide

uShip APIs provide for up-to-date tracking of your shipments for transparency throughout the delivery process. In order to leverage our tracking APIs, the following criteria must be met:

You must be authenticated to obtain the tracking link. However, once the link has been obtained, you do not need to be logged in or authenticated to view it.

The listing must have already been booked to view this URL in the response.

Navigating to the link prior to booking will result in a 404 error. The transportation service provider must have turned on location sharing. For more information on turning on location sharing, please see our help article.

Authorization

Use the following endpoint to authorize access to your account. Once successful, you will receive a 200 Success status and a "uShipTicket" cookie will be set. Retain this cookie for generating the tracking link.

POST https://www.uship.com/mvc/authentication/signin

Request Headers

content-type: application/json

cache-control: no-cache

Request Body

{

 "grant_type": "password", //don't change

 "userName": "uShip username or email",

 "password": "your password",

 "issuer": "None" //don't change

}

Generating Tracking Link

Using the listing ID, you can generate a link to the tracking page which will display the current location of the shipment at a city level.

GET https://www.uship.com/listing/track/{listingId}/trackinglink

Request Headers

cache-control: no-cache

Response

The response will return a tracking URL in the body, e.g.,

{ "TrackingLinkUrl": "https://www.uship.com/listing/track/398561542/f62fd4036353f1debb256db193c51fab8e0808f8b7f06d843eede559914da077/"}

Navigate to this URL or share this link to allow visibility into this shipment's status.