GET api/Shipper/TrackByTrackingNumber/{auth}/{TrackingNumber}
Track shipment by tracking number
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| auth |
Unique authorization identifier |
string |
Required |
| TrackingNumber |
Tracking number |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
TrackingResp| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful |
Set to true if method was successful |
boolean |
None. |
| ErrorMessage |
The error message if method call was not successful |
string |
None. |
| ShipmentGUID |
The unique internal shipment identifier |
string |
None. |
| TrackingNumber |
This is the value submitted for tracking |
string |
None. |
| ShipmentNumber |
This is the unique user visible order # available for all orders |
integer |
None. |
| ShowMap |
Display map to user? (true, false) |
boolean |
None. |
| ShowRates |
Display rates to user? (true, false) |
boolean |
None. |
| HideRouting |
Hide the routing from the user? (true, false) |
boolean |
None. |
| StatusDisplay |
Description of the current order status |
string |
None. |
| PickupAddressDisplay |
The complete picukp address |
string |
None. |
| DeliveryAddressDisplay |
The complete delivery address |
string |
None. |
| CurrentLatitude |
The current latitude location of the shipment |
decimal number |
None. |
| CurrentLongitude |
The current longitude location of the shipment |
decimal number |
None. |
| OrderDateTimeDisplay |
The date of the order |
string |
None. |
| OrderByName |
The name of the person who created the order |
string |
None. |
| Pieces |
The number of pieces in this shipment |
integer |
None. |
| Weight |
The total weight of the shipment |
decimal number |
None. |
| WeightUOM |
The weight unit (KG,LB) |
string |
None. |
| Reference |
The customers MAIN reference # for this order (other references are in the References element) |
string |
None. |
| Contents |
The contents of the shipment |
string |
None. |
| Itinerary |
The planned itinerary for this shipment |
Collection of ItineraryItem |
None. |
| Route |
The routing of the line haul (flights) |
Collection of RouteItem |
None. |
| Notes |
The customer visible notes associated with the order |
None. |
Response Formats
application/json, text/json
Sample not available.