GET api/Track/{TrackingNumber}/{UserGUID}
Used to get extended tracking information, secured so detailed information is available
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
UserGUID |
Unique system generated user identifier |
string |
Required |
TrackingNumber |
Tracking number of shipment |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
GetStatusResponseName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Tracking was successful (true/false) |
boolean |
Required |
ErrorMessage |
Error message if not successful |
string |
None. |
ShipmentNumber |
Unique system assign shipment number |
integer |
Required |
TrackingNumber |
House waybill number |
string |
Max length: 20 |
Pieces |
Number of pieces in shipment |
integer |
Required |
Weight |
Total weight of shipment |
decimal number |
None. |
WeightUOM |
Weight unit of measure (LB,KG) |
string |
Max length: 2 |
ServiceCode |
Service code |
string |
Max length: 15 |
ServiceName |
Service name |
string |
Max length: 40 |
Contents |
Contents of shipment |
string |
Max length: 100 |
Reference |
Main reference value |
string |
Max length: 50 |
OtherReference1 |
Other reference value |
string |
Max length: 50 |
OtherReference2 |
Other reference value |
string |
Max length: 50 |
OtherReference3 |
Other reference value |
string |
Max length: 50 |
OtherReference4 |
Other reference value |
string |
Max length: 50 |
OtherReference5 |
Other reference value |
string |
Max length: 50 |
OtherReference6 |
Other reference value |
string |
Max length: 50 |
OtherReference7 |
Other reference value |
string |
Max length: 50 |
OtherReference8 |
Other reference value |
string |
Max length: 50 |
PickupCompanyName |
Company name at pickup address |
string |
Required Max length: 50 |
PickupAddress1 |
First line of street address |
string |
Max length: 50 |
PickupAddress2 |
Second line of street address |
string |
Max length: 50 |
PickupAddress3 |
Third line of street address |
string |
Max length: 50 |
PickupCityName |
City name at pickup address |
string |
Required Max length: 50 |
PickupStateProvID |
State or province code at pickup address |
string |
Max length: 3 |
PickupPostalCode |
Postal code at pickup address |
string |
Max length: 10 |
PickupCountryID |
Country ID at pickup address (ie. US) |
string |
Required Max length: 10 |
PickupCountryName |
Country name at pickup address |
string |
Max length: 50 |
PickupPersonToSee |
Name of person to see at pickup address |
string |
Max length: 50 |
PickupPhoneNumber |
Phone number at pickup address |
string |
Max length: 25 |
PickupInstructions |
Special instructions at pickup |
string |
Max length: 500 |
DeliveryCompanyName |
Company name at delivery address |
string |
Max length: 50 |
DeliveryAddress1 |
First address line at delivery address |
string |
Max length: 50 |
DeliveryAddress2 |
Second address line at delivery address |
string |
Max length: 50 |
DeliveryAddress3 |
Third address line at delivery address |
string |
Max length: 50 |
DeliveryCityName |
City name at delivery address |
string |
Max length: 50 |
DeliveryStateProvID |
State or province code at delivery address |
string |
Max length: 3 |
DeliveryPostalCode |
Postal code at delivery address |
string |
Max length: 10 |
DeliveryCountryID |
Country code at delivery address (ie. US) |
string |
Max length: 2 |
DeliveryCountryName |
Country name at delivery address |
string |
Max length: 50 |
DeliveryAttention |
Attention person at delivery address |
string |
Max length: 50 |
DeliveryPhoneNumber |
Phone number at delivery address |
string |
Max length: 25 |
DeliveryEmailAddress |
Email address at delivery address |
string |
Max length: 100 |
DeliveryInstructions |
Special instructions at delivery |
string |
Max length: 500 |
ReadyDateTime |
Date/Time package is ready for pickup in timezone of pickup address (yyyy-MM-dd HH:mm) |
string |
Required Max length: 16 |
EstimatedPickupDateTime |
Estimated date/time that shipment will be picked-up in timezone of pickup (yyyy-MM-dd HH:mm) |
string |
Required Max length: 16 |
ActualPickupDateTime |
Actual date/time that shipment was picked-up in timezone of pickup (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
EstimatedDeliveryDateTime |
Estimated delivery date/time in timezone of delivery (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
PodSignature |
The text name of signature for delivery |
string |
Max length: 50 |
PodDateTime |
The date/time that shipment was delivered (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
OrderStatus |
The status code of the order |
string |
Required |
OrderStatusName |
The full name of the status |
string |
Required |
DepartAirportID |
The departure airport ID |
string |
Max length: 3 |
DepartAirlineName |
The name of airline at departure |
string |
Max length: 50 |
DepartIataID |
The departure airlines IATA ID code |
string |
Max length: 2 |
DepartFlightNumber |
The flight number of departure |
string |
Max length: 20 |
DepartEstimatedDateTime |
The estimated time of departure in departure timezone (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
DepartActualDateTime |
The actual time of departure in departure timezone (yyyy-MM_dd HH:mm) |
string |
Max length: 16 |
ArriveAirportID |
The arrival airport ID |
string |
Max length: 3 |
ArriveAirlineName |
The name of the arrival airline |
string |
Max length: 50 |
ArriveIataID |
The IATA ID of the arrival airline |
string |
Max length: 2 |
ArriveFlightNumber |
The flight number of the arrival airline |
string |
Max length: 20 |
ArriveEstimatedDateTime |
The estimated arrival time in timezone of arrival airport (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
ArriveActualDateTime |
The actual arrival time in timezone of arrival airport (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
OrderReceivedDateTimeUTC |
The date/time the order was received (UTC) (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
ReadyDateTimeUTC |
The ready datetime in UTC (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
EstimatedPickupDateTimeUTC |
The estimated pickup time in UTC (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
ActualPickupDateTimeUTC |
The actual pickup time in UTC (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
EstimatedDeliveryDateTimeUTC |
The estimated delivery date/time in UTC (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
PodDateTimeUTC |
The actual delivery date/time in UTC (yyyy-MM-dd HH:mm) |
string |
Max length: 16 |
PieceReferences |
Comma separated list of reference assigned to pieces (detail) |
string |
None. |
WaybillNumberFirst |
MAWB # assigned to first manifest |
string |
None. |
WaybillNumberLast |
MAWB # assigned to last manifest (same as MawbNumberFirst if only one manifest) |
string |
None. |
Response Formats
application/json, text/json
{ "ActualPickupDateTime": "sample string 46", "ActualPickupDateTimeUTC": "sample string 67", "ArriveActualDateTime": "sample string 63", "ArriveAirlineName": "sample string 59", "ArriveAirportID": "sample string 58", "ArriveEstimatedDateTime": "sample string 62", "ArriveFlightNumber": "sample string 61", "ArriveIataID": "sample string 60", "Contents": "sample string 9", "DeliveryAddress1": "sample string 32", "DeliveryAddress2": "sample string 33", "DeliveryAddress3": "sample string 34", "DeliveryAttention": "sample string 40", "DeliveryCityName": "sample string 35", "DeliveryCompanyName": "sample string 31", "DeliveryCountryID": "sample string 38", "DeliveryCountryName": "sample string 39", "DeliveryEmailAddress": "sample string 42", "DeliveryInstructions": "sample string 43", "DeliveryPhoneNumber": "sample string 41", "DeliveryPostalCode": "sample string 37", "DeliveryStateProvID": "sample string 36", "DepartActualDateTime": "sample string 57", "DepartAirlineName": "sample string 53", "DepartAirportID": "sample string 52", "DepartEstimatedDateTime": "sample string 56", "DepartFlightNumber": "sample string 55", "DepartIataID": "sample string 54", "ErrorMessage": "sample string 2", "EstimatedDeliveryDateTime": "sample string 47", "EstimatedDeliveryDateTimeUTC": "sample string 68", "EstimatedPickupDateTime": "sample string 45", "EstimatedPickupDateTimeUTC": "sample string 66", "IsSuccessful": true, "OrderReceivedDateTimeUTC": "sample string 64", "OrderStatus": "sample string 50", "OrderStatusName": "sample string 51", "OtherReference1": "sample string 11", "OtherReference2": "sample string 12", "OtherReference3": "sample string 13", "OtherReference4": "sample string 14", "OtherReference5": "sample string 15", "OtherReference6": "sample string 16", "OtherReference7": "sample string 17", "OtherReference8": "sample string 18", "PickupAddress1": "sample string 20", "PickupAddress2": "sample string 21", "PickupAddress3": "sample string 22", "PickupCityName": "sample string 23", "PickupCompanyName": "sample string 19", "PickupCountryID": "sample string 26", "PickupCountryName": "sample string 27", "PickupInstructions": "sample string 30", "PickupPersonToSee": "sample string 28", "PickupPhoneNumber": "sample string 29", "PickupPostalCode": "sample string 25", "PickupStateProvID": "sample string 24", "PieceReferences": "sample string 70", "Pieces": 5, "PodDateTime": "sample string 49", "PodDateTimeUTC": "sample string 69", "PodSignature": "sample string 48", "ReadyDateTime": "sample string 44", "ReadyDateTimeUTC": "sample string 65", "Reference": "sample string 10", "ServiceCode": "sample string 7", "ServiceName": "sample string 8", "ShipmentNumber": 3, "TrackingNumber": "sample string 4", "WaybillNumberFirst": "sample string 71", "WaybillNumberLast": "sample string 72", "Weight": 1, "WeightUOM": "sample string 6" }
application/xml, text/xml
<GetStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <ActualPickupDateTime>sample string 46</ActualPickupDateTime> <ActualPickupDateTimeUTC>sample string 67</ActualPickupDateTimeUTC> <ArriveActualDateTime>sample string 63</ArriveActualDateTime> <ArriveAirlineName>sample string 59</ArriveAirlineName> <ArriveAirportID>sample string 58</ArriveAirportID> <ArriveEstimatedDateTime>sample string 62</ArriveEstimatedDateTime> <ArriveFlightNumber>sample string 61</ArriveFlightNumber> <ArriveIataID>sample string 60</ArriveIataID> <Contents>sample string 9</Contents> <DeliveryAddress1>sample string 32</DeliveryAddress1> <DeliveryAddress2>sample string 33</DeliveryAddress2> <DeliveryAddress3>sample string 34</DeliveryAddress3> <DeliveryAttention>sample string 40</DeliveryAttention> <DeliveryCityName>sample string 35</DeliveryCityName> <DeliveryCompanyName>sample string 31</DeliveryCompanyName> <DeliveryCountryID>sample string 38</DeliveryCountryID> <DeliveryCountryName>sample string 39</DeliveryCountryName> <DeliveryEmailAddress>sample string 42</DeliveryEmailAddress> <DeliveryInstructions>sample string 43</DeliveryInstructions> <DeliveryPhoneNumber>sample string 41</DeliveryPhoneNumber> <DeliveryPostalCode>sample string 37</DeliveryPostalCode> <DeliveryStateProvID>sample string 36</DeliveryStateProvID> <DepartActualDateTime>sample string 57</DepartActualDateTime> <DepartAirlineName>sample string 53</DepartAirlineName> <DepartAirportID>sample string 52</DepartAirportID> <DepartEstimatedDateTime>sample string 56</DepartEstimatedDateTime> <DepartFlightNumber>sample string 55</DepartFlightNumber> <DepartIataID>sample string 54</DepartIataID> <ErrorMessage>sample string 2</ErrorMessage> <EstimatedDeliveryDateTime>sample string 47</EstimatedDeliveryDateTime> <EstimatedDeliveryDateTimeUTC>sample string 68</EstimatedDeliveryDateTimeUTC> <EstimatedPickupDateTime>sample string 45</EstimatedPickupDateTime> <EstimatedPickupDateTimeUTC>sample string 66</EstimatedPickupDateTimeUTC> <IsSuccessful>true</IsSuccessful> <OrderReceivedDateTimeUTC>sample string 64</OrderReceivedDateTimeUTC> <OrderStatus>sample string 50</OrderStatus> <OrderStatusName>sample string 51</OrderStatusName> <OtherReference1>sample string 11</OtherReference1> <OtherReference2>sample string 12</OtherReference2> <OtherReference3>sample string 13</OtherReference3> <OtherReference4>sample string 14</OtherReference4> <OtherReference5>sample string 15</OtherReference5> <OtherReference6>sample string 16</OtherReference6> <OtherReference7>sample string 17</OtherReference7> <OtherReference8>sample string 18</OtherReference8> <PickupAddress1>sample string 20</PickupAddress1> <PickupAddress2>sample string 21</PickupAddress2> <PickupAddress3>sample string 22</PickupAddress3> <PickupCityName>sample string 23</PickupCityName> <PickupCompanyName>sample string 19</PickupCompanyName> <PickupCountryID>sample string 26</PickupCountryID> <PickupCountryName>sample string 27</PickupCountryName> <PickupInstructions>sample string 30</PickupInstructions> <PickupPersonToSee>sample string 28</PickupPersonToSee> <PickupPhoneNumber>sample string 29</PickupPhoneNumber> <PickupPostalCode>sample string 25</PickupPostalCode> <PickupStateProvID>sample string 24</PickupStateProvID> <PieceReferences>sample string 70</PieceReferences> <Pieces>5</Pieces> <PodDateTime>sample string 49</PodDateTime> <PodDateTimeUTC>sample string 69</PodDateTimeUTC> <PodSignature>sample string 48</PodSignature> <ReadyDateTime>sample string 44</ReadyDateTime> <ReadyDateTimeUTC>sample string 65</ReadyDateTimeUTC> <Reference>sample string 10</Reference> <ServiceCode>sample string 7</ServiceCode> <ServiceName>sample string 8</ServiceName> <ShipmentNumber>3</ShipmentNumber> <TrackingNumber>sample string 4</TrackingNumber> <WaybillNumberFirst>sample string 71</WaybillNumberFirst> <WaybillNumberLast>sample string 72</WaybillNumberLast> <Weight>1</Weight> <WeightUOM>sample string 6</WeightUOM> </GetStatusResponse>