Tracking

uShip provides three options for receiving tracking statuses and relevant data for your shipments. Please see the table below for detail on each of these options and which would best suit your integration plan. For each option, the transit statuses available are: ReadyForDispatch, Dispatched, PickedUp, Delivered . As uShip's model focuses on a single carrier from origin to destination, there are not waypoints or other steps noted.

	Tracking Link Generation	Status Retrieval	Full Tracking Data
Visible to unauthenticated users?	Account owners can generate a link that unauthenticated users can view	You can retrieve tracking data for listings not under your uShip account	Tracking data can only be retrieved for listings on your uShip account
Displays transit status?	Yes	Yes	Yes
Allows data to be shown on your page?	You can only display the link to the uShip hosted tracking page	Yes, you can surface specific parameters on your page. Users will not need to leave your site.	Yes, you can surface specific parameters on your page. Users will not need to leave your site.
Supports location data?	Yes, if carrier enables location services	No	Yes, if carrier enables location services
Additional documentation	Please request the tracking link slide deck from your account or integrations manager	See sample JSON Payload response below	https://uship.developerhub.io/uship-furniture-api-reference/ref#getretrieve-tracking-info

Status Retrieval Example Users authenticate with password grant token and use endpoint GET v2/listings/{listingID} to retrieve payload values as shown below

JSON
    
    
 
{
    "status": {...},
    "transitStatus": {...},
    "namedPrice": {...},
    "offerPrice": {...},
    "commodity": "Furniture",    "parentCommodity": "Household Goods",    "topLevelCommodity": "Household Goods",    "expiresOn": "2020-10-23T04:59:59Z",    "imageUrl": "https://s.ushipcdn.com/public/images/icons/categories/114x138/1_114x138.png",    "isDefaultImage": true,    "checksum": "d131bab40a8f368d",    "createdOn": "2020-10-22T16:46:34Z",    "activatedOn": "2020-10-22T16:46:34Z",    "lastUpdatedOn": "2020-10-22T16:46:34Z",    "minimumBidAmount": {...},
    "quoteRequestId": "5f91b76a4eeb8a22707a04ad",    "commodityType": {...},
    "parentCommodityType": {...},
    "topLevelCommodityType": {...},
    "serviceTypes": [...],
    "listingId": 723558412,    "title": "Marble Top Side Table B-5940546",    "description": "**PLEASE CONFIRM YOU HAVE READ THESE DETAILS IN BID**:\r\n- Pickup is between 10:00 AM-5:00 PM Mon-Fri \r\n- Pickup is from a warehouse, ground level, no loading dock. \r\n- You MUST be able to load and unload the item(s) without the assistance of our employees or our customers. \r\n- You MUST use the BOL which can be found in My Shipments under the Assigned Tab. Print the BOL and fill out the necessary information. \r\n- You MUST make contact with the delivery customer at least 24 hours in advance. If you deliver an item less than 24 hours from pickup without the customer’s approval, you will not be paid in full. \r\n- Items can not be left outside unless consent is given from the customer. \r\n- Customers should be contacted between 7:30am-8:30pm based on the delivery timezone. \r\n- An enclosed trailer, box truck, or sprinter van is required for ALL deliveries.\r\n- Threshold delivery.\r\n- IF ANY OF THESE REQUIREMENTS ARE NOT MET, WE WILL NO LONGER BE ABLE TO WORK TOGETHER.\r\n*(please note that all weights are estimated)",    "route": {...},
    "lister": {...},
    "items": [...],
    "totalWeightInGrams": {...},
    "attributes": {...},
    "referenceNumbers": [...],
    "links": [...]
}
Copy

Last updated on