POST api/Track
Used to get detailed tracking information for secured connection
Request Information
URI Parameters
None.
Body Parameters
TrackParmName | Description | Type | Additional information |
---|---|---|---|
auth |
Authorization token |
string |
None. |
TrackingNumber |
Tracking number (required if ShipmentGUID is null) |
string |
None. |
ShipmentGUID |
Internal Shipment identifier (required if TrackingNumber is null) |
string |
None. |
ShowMap |
Show map (calculate geolocation on every tracking) (use value from response to authentication method) |
boolean |
None. |
ShowRates |
Show rates (use value from response to authentication method) |
boolean |
None. |
HideRouting |
Hide routing information (use value from response to authentication method) |
boolean |
None. |
Request Formats
application/json, text/json
{ "HideRouting": true, "ShipmentGUID": "sample string 3", "ShowMap": true, "ShowRates": true, "TrackingNumber": "sample string 2", "auth": "sample string 1" }
application/xml, text/xml
<TrackParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <HideRouting>true</HideRouting> <ShipmentGUID>sample string 3</ShipmentGUID> <ShowMap>true</ShowMap> <ShowRates>true</ShowRates> <TrackingNumber>sample string 2</TrackingNumber> <auth>sample string 1</auth> </TrackParm>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
TrackRespName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Used to determine if method call was successful (true) or failure (false) |
boolean |
None. |
ErrorMessage |
The error message if method call was not successful |
string |
None. |
ShipmentGUID | string |
None. |
|
ShipmentNumber | integer |
None. |
|
TrackingNumber | string |
None. |
|
StatusDisplay | string |
None. |
|
OrderState | string |
None. |
|
OrderStatus | integer |
None. |
|
OrderByName | string |
None. |
|
OrderByPhone | string |
None. |
|
OrderDateTime | string |
None. |
|
OrderDateTimeDisplay | string |
None. |
|
Contents | string |
None. |
|
PickupAddress | string |
None. |
|
PickupCompanyName | string |
None. |
|
PickupAddress1 | string |
None. |
|
PickupAddress2 | string |
None. |
|
PickupAddress3 | string |
None. |
|
PickupCityName | string |
None. |
|
PickupStateProvID | string |
None. |
|
PickupPostalCode | string |
None. |
|
PickupCountryID | string |
None. |
|
PickupCountryName | string |
None. |
|
PickupPersonToSee | string |
None. |
|
PickupPhoneNumber | string |
None. |
|
PickupEmailAddress | string |
None. |
|
PickupReadyDateTime | string |
None. |
|
PickupUpdatedDateTime | string |
None. |
|
PickupAlertDateTime | string |
None. |
|
PickupActualDateTime | string |
None. |
|
DeliveryAddress | string |
None. |
|
DeliveryAddress1 | string |
None. |
|
DeliveryAddress2 | string |
None. |
|
DeliveryAddress3 | string |
None. |
|
DeliveryAttention | string |
None. |
|
DeliveryCityName | string |
None. |
|
DeliveryStateProvID | string |
None. |
|
DeliveryCompanyName | string |
None. |
|
DeliveryCountryID | string |
None. |
|
DeliveryCountryName | string |
None. |
|
DeliveryEmailAddress | string |
None. |
|
DeliveryPhoneNumber | string |
None. |
|
DeliveryPostalCode | string |
None. |
|
HoldForPickup | boolean |
None. |
|
RecoverAirportID | string |
None. |
|
DeliveryUpdatedDateTime | string |
None. |
|
DeliveryActualDateTime | string |
None. |
|
DeliverySignature | string |
None. |
|
DeliveryActualDateTimeUTC | string |
None. |
|
DeliveryUpdatedDateTimeUTC | string |
None. |
|
OrderDateTimeUTC | string |
None. |
|
PickupActualDateTimeUTC | string |
None. |
|
PickupAlertDateTimeUTC | string |
None. |
|
PickupReadyDateTimeUTC | string |
None. |
|
PickupUpdatedDateTimeUTC | string |
None. |
|
GpsTrackingUrl | string |
None. |
|
Pieces | integer |
None. |
|
Weight | decimal number |
None. |
|
WeightUOM | string |
None. |
|
Reference | string |
None. |
|
ReferenceLabel | string |
None. |
|
ServiceID | integer |
None. |
|
ServiceCode | string |
None. |
|
ServiceName | string |
None. |
|
SignatureImage | string |
None. |
|
WaybillNumber | string |
None. |
|
MapDisplayDateTime | string |
None. |
|
MapErrorMessage | string |
None. |
|
MapEstimatedDeliveryDateTime | string |
None. |
|
MapLatitude | string |
None. |
|
MapLongitude | string |
None. |
|
MapPushPinType | string |
None. |
|
Itinerary | Collection of ItineraryItem |
None. |
|
Route | Collection of RouteItem |
None. |
|
Notes | Collection of NotesItem |
None. |
|
Charges | Collection of ChargeItem |
None. |
|
References | Collection of ReferenceItem |
None. |
|
Documents | Collection of DocumentItem |
None. |
|
PieceList | Collection of PieceItem |
None. |
|
IsOnWatchList |
True = shipment is on watch list |
boolean |
None. |
Response Formats
application/json, text/json
{ "Charges": [ { "Amount": 1, "CurrencyID": "sample string 2", "Description": "sample string 3", "InvoiceNumber": 1, "Name": "sample string 4", "NetAmount": 5, "Status": "sample string 6", "TaxAmount": 7 }, { "Amount": 1, "CurrencyID": "sample string 2", "Description": "sample string 3", "InvoiceNumber": 1, "Name": "sample string 4", "NetAmount": 5, "Status": "sample string 6", "TaxAmount": 7 } ], "Contents": "sample string 12", "DeliveryActualDateTime": "sample string 46", "DeliveryActualDateTimeUTC": "sample string 48", "DeliveryAddress": "sample string 30", "DeliveryAddress1": "sample string 31", "DeliveryAddress2": "sample string 32", "DeliveryAddress3": "sample string 33", "DeliveryAttention": "sample string 34", "DeliveryCityName": "sample string 35", "DeliveryCompanyName": "sample string 37", "DeliveryCountryID": "sample string 38", "DeliveryCountryName": "sample string 39", "DeliveryEmailAddress": "sample string 40", "DeliveryPhoneNumber": "sample string 41", "DeliveryPostalCode": "sample string 42", "DeliverySignature": "sample string 47", "DeliveryStateProvID": "sample string 36", "DeliveryUpdatedDateTime": "sample string 45", "DeliveryUpdatedDateTimeUTC": "sample string 49", "Documents": [ { "Description": "sample string 3", "Name": "sample string 2", "OriginalFileName": "sample string 4", "ShipmentDocumentID": 1 }, { "Description": "sample string 3", "Name": "sample string 2", "OriginalFileName": "sample string 4", "ShipmentDocumentID": 1 } ], "ErrorMessage": "sample string 2", "GpsTrackingUrl": "sample string 55", "HoldForPickup": true, "IsOnWatchList": true, "IsSuccessful": true, "Itinerary": [ { "CompletedDateTime": "sample string 5", "CompletedDateTimeLocal": "sample string 7", "PlannedDateTime": "sample string 4", "PlannedDateTimeLocal": "sample string 6", "StepDescription": "sample string 3", "StepName": "sample string 2", "StepSequence": 1 }, { "CompletedDateTime": "sample string 5", "CompletedDateTimeLocal": "sample string 7", "PlannedDateTime": "sample string 4", "PlannedDateTimeLocal": "sample string 6", "StepDescription": "sample string 3", "StepName": "sample string 2", "StepSequence": 1 } ], "MapDisplayDateTime": "sample string 63", "MapErrorMessage": "sample string 64", "MapEstimatedDeliveryDateTime": "sample string 65", "MapLatitude": "sample string 66", "MapLongitude": "sample string 67", "MapPushPinType": "sample string 68", "Notes": [ { "CreatedDateTime": "2025-04-03T08:34:32.785-07:00", "Note": "sample string 2" }, { "CreatedDateTime": "2025-04-03T08:34:32.785-07:00", "Note": "sample string 2" } ], "OrderByName": "sample string 8", "OrderByPhone": "sample string 9", "OrderDateTime": "sample string 10", "OrderDateTimeDisplay": "sample string 11", "OrderDateTimeUTC": "sample string 50", "OrderState": "sample string 6", "OrderStatus": 7, "PickupActualDateTime": "sample string 29", "PickupActualDateTimeUTC": "sample string 51", "PickupAddress": "sample string 13", "PickupAddress1": "sample string 15", "PickupAddress2": "sample string 16", "PickupAddress3": "sample string 17", "PickupAlertDateTime": "sample string 28", "PickupAlertDateTimeUTC": "sample string 52", "PickupCityName": "sample string 18", "PickupCompanyName": "sample string 14", "PickupCountryID": "sample string 21", "PickupCountryName": "sample string 22", "PickupEmailAddress": "sample string 25", "PickupPersonToSee": "sample string 23", "PickupPhoneNumber": "sample string 24", "PickupPostalCode": "sample string 20", "PickupReadyDateTime": "sample string 26", "PickupReadyDateTimeUTC": "sample string 53", "PickupStateProvID": "sample string 19", "PickupUpdatedDateTime": "sample string 27", "PickupUpdatedDateTimeUTC": "sample string 54", "PieceList": [ { "CarrierToProvideDryIce": true, "CarrierToProvideGelPack": true, "Contents": "sample string 6", "CountryOfOrigin": "sample string 10", "DeclaredValue": 1, "DeclaredValueCurrencyID": "sample string 8", "DgCommodityClass": "sample string 15", "DgDryIceWeight": 1, "DgGelPackCount": 1, "DgProperName": "sample string 16", "DgUNNumber": "sample string 14", "HSCode": "sample string 9", "Height": "sample string 4", "IsDangerousGoods": true, "IsRadioactive": true, "Length": "sample string 2", "PackagingTypeCode": "sample string 19", "PackagingTypeCodeInner": "sample string 20", "Quantity": 21, "Reference": "sample string 7", "SizeUOM": "sample string 5", "TemperatureType": "sample string 11", "Weight": 1, "WeightUOM": "sample string 1", "Width": "sample string 3" }, { "CarrierToProvideDryIce": true, "CarrierToProvideGelPack": true, "Contents": "sample string 6", "CountryOfOrigin": "sample string 10", "DeclaredValue": 1, "DeclaredValueCurrencyID": "sample string 8", "DgCommodityClass": "sample string 15", "DgDryIceWeight": 1, "DgGelPackCount": 1, "DgProperName": "sample string 16", "DgUNNumber": "sample string 14", "HSCode": "sample string 9", "Height": "sample string 4", "IsDangerousGoods": true, "IsRadioactive": true, "Length": "sample string 2", "PackagingTypeCode": "sample string 19", "PackagingTypeCodeInner": "sample string 20", "Quantity": 21, "Reference": "sample string 7", "SizeUOM": "sample string 5", "TemperatureType": "sample string 11", "Weight": 1, "WeightUOM": "sample string 1", "Width": "sample string 3" } ], "Pieces": 1, "RecoverAirportID": "sample string 44", "Reference": "sample string 57", "ReferenceLabel": "sample string 58", "References": [ { "Name": "sample string 1", "ReferenceTypeID": 2, "Value": "sample string 3" }, { "Name": "sample string 1", "ReferenceTypeID": 2, "Value": "sample string 3" } ], "Route": [ { "ArriveDateTime": "sample string 1", "ArriveDateTimeDisplay": "sample string 2", "ArriveHubID": "sample string 3", "CarrierIataID": "sample string 4", "CarrierName": "sample string 5", "DepartDateTime": "sample string 6", "DepartDateTimeDisplay": "sample string 7", "DepartHubID": "sample string 8", "MapImageUrl": "sample string 9", "MapImageVisible": true, "RouteNumber": "sample string 11", "SequenceNumber": 12, "StatusDisplay": "sample string 13" }, { "ArriveDateTime": "sample string 1", "ArriveDateTimeDisplay": "sample string 2", "ArriveHubID": "sample string 3", "CarrierIataID": "sample string 4", "CarrierName": "sample string 5", "DepartDateTime": "sample string 6", "DepartDateTimeDisplay": "sample string 7", "DepartHubID": "sample string 8", "MapImageUrl": "sample string 9", "MapImageVisible": true, "RouteNumber": "sample string 11", "SequenceNumber": 12, "StatusDisplay": "sample string 13" } ], "ServiceCode": "sample string 59", "ServiceID": 1, "ServiceName": "sample string 60", "ShipmentGUID": "sample string 3", "ShipmentNumber": 1, "SignatureImage": "sample string 61", "StatusDisplay": "sample string 5", "TrackingNumber": "sample string 4", "WaybillNumber": "sample string 62", "Weight": 1, "WeightUOM": "sample string 56" }
application/xml, text/xml
<TrackResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <Charges> <ChargeItem> <Amount>1</Amount> <CurrencyID>sample string 2</CurrencyID> <Description>sample string 3</Description> <InvoiceNumber>1</InvoiceNumber> <Name>sample string 4</Name> <NetAmount>5</NetAmount> <Status>sample string 6</Status> <TaxAmount>7</TaxAmount> </ChargeItem> <ChargeItem> <Amount>1</Amount> <CurrencyID>sample string 2</CurrencyID> <Description>sample string 3</Description> <InvoiceNumber>1</InvoiceNumber> <Name>sample string 4</Name> <NetAmount>5</NetAmount> <Status>sample string 6</Status> <TaxAmount>7</TaxAmount> </ChargeItem> </Charges> <Contents>sample string 12</Contents> <DeliveryActualDateTime>sample string 46</DeliveryActualDateTime> <DeliveryActualDateTimeUTC>sample string 48</DeliveryActualDateTimeUTC> <DeliveryAddress>sample string 30</DeliveryAddress> <DeliveryAddress1>sample string 31</DeliveryAddress1> <DeliveryAddress2>sample string 32</DeliveryAddress2> <DeliveryAddress3>sample string 33</DeliveryAddress3> <DeliveryAttention>sample string 34</DeliveryAttention> <DeliveryCityName>sample string 35</DeliveryCityName> <DeliveryCompanyName>sample string 37</DeliveryCompanyName> <DeliveryCountryID>sample string 38</DeliveryCountryID> <DeliveryCountryName>sample string 39</DeliveryCountryName> <DeliveryEmailAddress>sample string 40</DeliveryEmailAddress> <DeliveryPhoneNumber>sample string 41</DeliveryPhoneNumber> <DeliveryPostalCode>sample string 42</DeliveryPostalCode> <DeliverySignature>sample string 47</DeliverySignature> <DeliveryStateProvID>sample string 36</DeliveryStateProvID> <DeliveryUpdatedDateTime>sample string 45</DeliveryUpdatedDateTime> <DeliveryUpdatedDateTimeUTC>sample string 49</DeliveryUpdatedDateTimeUTC> <Documents> <DocumentItem> <Description>sample string 3</Description> <Name>sample string 2</Name> <OriginalFileName>sample string 4</OriginalFileName> <ShipmentDocumentID>1</ShipmentDocumentID> </DocumentItem> <DocumentItem> <Description>sample string 3</Description> <Name>sample string 2</Name> <OriginalFileName>sample string 4</OriginalFileName> <ShipmentDocumentID>1</ShipmentDocumentID> </DocumentItem> </Documents> <ErrorMessage>sample string 2</ErrorMessage> <GpsTrackingUrl>sample string 55</GpsTrackingUrl> <HoldForPickup>true</HoldForPickup> <IsOnWatchList>true</IsOnWatchList> <IsSuccessful>true</IsSuccessful> <Itinerary> <ItineraryItem> <CompletedDateTime>sample string 5</CompletedDateTime> <CompletedDateTimeLocal>sample string 7</CompletedDateTimeLocal> <PlannedDateTime>sample string 4</PlannedDateTime> <PlannedDateTimeLocal>sample string 6</PlannedDateTimeLocal> <StepDescription>sample string 3</StepDescription> <StepName>sample string 2</StepName> <StepSequence>1</StepSequence> </ItineraryItem> <ItineraryItem> <CompletedDateTime>sample string 5</CompletedDateTime> <CompletedDateTimeLocal>sample string 7</CompletedDateTimeLocal> <PlannedDateTime>sample string 4</PlannedDateTime> <PlannedDateTimeLocal>sample string 6</PlannedDateTimeLocal> <StepDescription>sample string 3</StepDescription> <StepName>sample string 2</StepName> <StepSequence>1</StepSequence> </ItineraryItem> </Itinerary> <MapDisplayDateTime>sample string 63</MapDisplayDateTime> <MapErrorMessage>sample string 64</MapErrorMessage> <MapEstimatedDeliveryDateTime>sample string 65</MapEstimatedDeliveryDateTime> <MapLatitude>sample string 66</MapLatitude> <MapLongitude>sample string 67</MapLongitude> <MapPushPinType>sample string 68</MapPushPinType> <Notes> <NotesItem> <CreatedDateTime>2025-04-03T08:34:32.7855907-07:00</CreatedDateTime> <Note>sample string 2</Note> </NotesItem> <NotesItem> <CreatedDateTime>2025-04-03T08:34:32.7855907-07:00</CreatedDateTime> <Note>sample string 2</Note> </NotesItem> </Notes> <OrderByName>sample string 8</OrderByName> <OrderByPhone>sample string 9</OrderByPhone> <OrderDateTime>sample string 10</OrderDateTime> <OrderDateTimeDisplay>sample string 11</OrderDateTimeDisplay> <OrderDateTimeUTC>sample string 50</OrderDateTimeUTC> <OrderState>sample string 6</OrderState> <OrderStatus>7</OrderStatus> <PickupActualDateTime>sample string 29</PickupActualDateTime> <PickupActualDateTimeUTC>sample string 51</PickupActualDateTimeUTC> <PickupAddress>sample string 13</PickupAddress> <PickupAddress1>sample string 15</PickupAddress1> <PickupAddress2>sample string 16</PickupAddress2> <PickupAddress3>sample string 17</PickupAddress3> <PickupAlertDateTime>sample string 28</PickupAlertDateTime> <PickupAlertDateTimeUTC>sample string 52</PickupAlertDateTimeUTC> <PickupCityName>sample string 18</PickupCityName> <PickupCompanyName>sample string 14</PickupCompanyName> <PickupCountryID>sample string 21</PickupCountryID> <PickupCountryName>sample string 22</PickupCountryName> <PickupEmailAddress>sample string 25</PickupEmailAddress> <PickupPersonToSee>sample string 23</PickupPersonToSee> <PickupPhoneNumber>sample string 24</PickupPhoneNumber> <PickupPostalCode>sample string 20</PickupPostalCode> <PickupReadyDateTime>sample string 26</PickupReadyDateTime> <PickupReadyDateTimeUTC>sample string 53</PickupReadyDateTimeUTC> <PickupStateProvID>sample string 19</PickupStateProvID> <PickupUpdatedDateTime>sample string 27</PickupUpdatedDateTime> <PickupUpdatedDateTimeUTC>sample string 54</PickupUpdatedDateTimeUTC> <PieceList> <PieceItem> <CarrierToProvideDryIce>true</CarrierToProvideDryIce> <CarrierToProvideGelPack>true</CarrierToProvideGelPack> <Contents>sample string 6</Contents> <CountryOfOrigin>sample string 10</CountryOfOrigin> <DeclaredValue>1</DeclaredValue> <DeclaredValueCurrencyID>sample string 8</DeclaredValueCurrencyID> <DgCommodityClass>sample string 15</DgCommodityClass> <DgDryIceWeight>1</DgDryIceWeight> <DgGelPackCount>1</DgGelPackCount> <DgProperName>sample string 16</DgProperName> <DgUNNumber>sample string 14</DgUNNumber> <HSCode>sample string 9</HSCode> <Height>sample string 4</Height> <IsDangerousGoods>true</IsDangerousGoods> <IsRadioactive>true</IsRadioactive> <Length>sample string 2</Length> <PackagingTypeCode>sample string 19</PackagingTypeCode> <PackagingTypeCodeInner>sample string 20</PackagingTypeCodeInner> <Quantity>21</Quantity> <Reference>sample string 7</Reference> <SizeUOM>sample string 5</SizeUOM> <TemperatureType>sample string 11</TemperatureType> <Weight>1</Weight> <WeightUOM>sample string 1</WeightUOM> <Width>sample string 3</Width> </PieceItem> <PieceItem> <CarrierToProvideDryIce>true</CarrierToProvideDryIce> <CarrierToProvideGelPack>true</CarrierToProvideGelPack> <Contents>sample string 6</Contents> <CountryOfOrigin>sample string 10</CountryOfOrigin> <DeclaredValue>1</DeclaredValue> <DeclaredValueCurrencyID>sample string 8</DeclaredValueCurrencyID> <DgCommodityClass>sample string 15</DgCommodityClass> <DgDryIceWeight>1</DgDryIceWeight> <DgGelPackCount>1</DgGelPackCount> <DgProperName>sample string 16</DgProperName> <DgUNNumber>sample string 14</DgUNNumber> <HSCode>sample string 9</HSCode> <Height>sample string 4</Height> <IsDangerousGoods>true</IsDangerousGoods> <IsRadioactive>true</IsRadioactive> <Length>sample string 2</Length> <PackagingTypeCode>sample string 19</PackagingTypeCode> <PackagingTypeCodeInner>sample string 20</PackagingTypeCodeInner> <Quantity>21</Quantity> <Reference>sample string 7</Reference> <SizeUOM>sample string 5</SizeUOM> <TemperatureType>sample string 11</TemperatureType> <Weight>1</Weight> <WeightUOM>sample string 1</WeightUOM> <Width>sample string 3</Width> </PieceItem> </PieceList> <Pieces>1</Pieces> <RecoverAirportID>sample string 44</RecoverAirportID> <Reference>sample string 57</Reference> <ReferenceLabel>sample string 58</ReferenceLabel> <References> <ReferenceItem> <Name>sample string 1</Name> <ReferenceTypeID>2</ReferenceTypeID> <Value>sample string 3</Value> </ReferenceItem> <ReferenceItem> <Name>sample string 1</Name> <ReferenceTypeID>2</ReferenceTypeID> <Value>sample string 3</Value> </ReferenceItem> </References> <Route> <RouteItem> <ArriveDateTime>sample string 1</ArriveDateTime> <ArriveDateTimeDisplay>sample string 2</ArriveDateTimeDisplay> <ArriveHubID>sample string 3</ArriveHubID> <CarrierIataID>sample string 4</CarrierIataID> <CarrierName>sample string 5</CarrierName> <DepartDateTime>sample string 6</DepartDateTime> <DepartDateTimeDisplay>sample string 7</DepartDateTimeDisplay> <DepartHubID>sample string 8</DepartHubID> <MapImageUrl>sample string 9</MapImageUrl> <MapImageVisible>true</MapImageVisible> <RouteNumber>sample string 11</RouteNumber> <SequenceNumber>12</SequenceNumber> <StatusDisplay>sample string 13</StatusDisplay> </RouteItem> <RouteItem> <ArriveDateTime>sample string 1</ArriveDateTime> <ArriveDateTimeDisplay>sample string 2</ArriveDateTimeDisplay> <ArriveHubID>sample string 3</ArriveHubID> <CarrierIataID>sample string 4</CarrierIataID> <CarrierName>sample string 5</CarrierName> <DepartDateTime>sample string 6</DepartDateTime> <DepartDateTimeDisplay>sample string 7</DepartDateTimeDisplay> <DepartHubID>sample string 8</DepartHubID> <MapImageUrl>sample string 9</MapImageUrl> <MapImageVisible>true</MapImageVisible> <RouteNumber>sample string 11</RouteNumber> <SequenceNumber>12</SequenceNumber> <StatusDisplay>sample string 13</StatusDisplay> </RouteItem> </Route> <ServiceCode>sample string 59</ServiceCode> <ServiceID>1</ServiceID> <ServiceName>sample string 60</ServiceName> <ShipmentGUID>sample string 3</ShipmentGUID> <ShipmentNumber>1</ShipmentNumber> <SignatureImage>sample string 61</SignatureImage> <StatusDisplay>sample string 5</StatusDisplay> <TrackingNumber>sample string 4</TrackingNumber> <WaybillNumber>sample string 62</WaybillNumber> <Weight>1</Weight> <WeightUOM>sample string 56</WeightUOM> </TrackResp>