Tracking API Call

Keep up to date on the transit status of your shipments by utilizing the tracking API Call

What is the Tracking API Call?

The Tracking Call retrieves the latest tracking update available for the given packageID or tracking number. 

Why is the Tracking API Call Useful?

The Tracking API Call is useful for various reasons depending on business needs. For example, if a customer's client is looking for details about the status of an order, the call can be used to find out the most recent status of the package directly from the carrier service. 

Which Carriers Currently Support the Tracking API Call?

• USPS
• DHL Domestic
• DHL Express
• UPS
• FedEx Cross Border
• FedEx
• Landmark
• FedEx Smart Post
• Aramex
• RRD
• Sendle
• Asendia
• Pitney Bowes Expedited
• Pitney Bowes Standard
• Pitney Bowes Cross Border
• Pitney Bowes Presort
• OSM DOM
• First Mile
• Canada Post
• Landmark

What Transit Updates Will I Receive?

Created: The shipment has been created but not entered the carrier's system.

In Transit: The shipment is moving through the carrier's network.

Delivered: The shipment has arrived at its Destination.

How to Set Up the Tracking API Call:

The tracking is a "Get" call in the Ship controller. You may use the tracking number or packageID as a variable in the call.

Example:

https://next_io.desktopshipper.com/api/v1/Ship/Tracking?TrackingNumber=inserttrackinghere
or
https://next_io.desktopshipper.com/api/v1/Ship/Tracking?packageid=insertpkgidhere

Important Data Fields

accountID: The account number utilized to create the shipment.

tracking Number: A unique number that is assigned to each package. Allows both the shipper and receiver to monitor the movement of the package.

description:  Description of the delivery status of the package. Examples: "Departed from Facility", "Delivered", "Processed".

statusName: Indicates the delivery status of the package. Examples: "Delivered", "InTransit".

lastUpdate: Last tracking update received from the carrier. DesktopShipper will send out a tracking request to the carrier each time the tracking endpoint is invoked.

estimatedDeliveryDate: The estimated date the package will be delivered.

shipDate: Date that the package was shipped in the DesktopShipper system.

Example Response: