POST api/Track/SearchOrders
Use this method to search for current and historial shipments
Request Information
URI Parameters
None.
Body Parameters
SearchOrdersParmName | Description | Type | Additional information |
---|---|---|---|
UserGUID |
Unique system assigned user identifier |
string |
Required Max length: 36 |
StartDate |
Start date of date range (pickup date) (yyyy-MM-dd) |
string |
Required Max length: 10 |
EndDate |
End date of date range (pickup date) (yyyy-MM-dd) |
string |
Required Max length: 10 |
AccountNumber |
Account number |
string |
Max length: 20 |
TrackingNumber |
The tracking number assigned to a shipment |
string |
Max length: 20 |
InvoiceNumber |
Invoice number |
string |
Max length: 10 |
OrderStatus |
Status of the order: (blank)=any order in the system that was cancelled, is active or delivered ACT=any active order in the system that is active or delivered DEL=any order in the system that is delivered by not billed BIL=Any order in the system that has been billed |
string |
Max length: 3 |
PickupCityName |
City name at pickup |
string |
Max length: 50 |
PickupStateProvID |
State or province ID at pickup |
string |
Max length: 3 |
PickupPostalCode |
Postal code at pickup |
string |
Max length: 10 |
PickupCountryID |
Country ID at pickup |
string |
Max length: 2 |
DeliveryCityName |
City name at delivery |
string |
Max length: 50 |
DeliveryStateProvID |
State or province code at delivery |
string |
Max length: 3 |
DeliveryPostalCode |
Postal code at delivery |
string |
Max length: 10 |
DeliveryCountryID |
Country ID as delivery |
string |
Max length: 2 |
Reference |
Main reference value |
string |
Max length: 50 |
Reference2 |
Other reference value |
string |
Max length: 50 |
Reference3 |
Other reference value |
string |
Max length: 50 |
Reference4 |
Other reference value |
string |
Max length: 50 |
Reference5 |
Other reference value |
string |
Max length: 50 |
Request Formats
application/json, text/json
{ "AccountNumber": "sample string 4", "DeliveryCityName": "sample string 12", "DeliveryCountryID": "sample string 15", "DeliveryPostalCode": "sample string 14", "DeliveryStateProvID": "sample string 13", "EndDate": "sample string 3", "InvoiceNumber": "sample string 6", "OrderStatus": "sample string 7", "PickupCityName": "sample string 8", "PickupCountryID": "sample string 11", "PickupPostalCode": "sample string 10", "PickupStateProvID": "sample string 9", "Reference": "sample string 16", "Reference2": "sample string 17", "Reference3": "sample string 18", "Reference4": "sample string 19", "Reference5": "sample string 20", "StartDate": "sample string 2", "TrackingNumber": "sample string 5", "UserGUID": "sample string 1" }
application/xml, text/xml
<SearchOrdersParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <AccountNumber>sample string 4</AccountNumber> <DeliveryCityName>sample string 12</DeliveryCityName> <DeliveryCountryID>sample string 15</DeliveryCountryID> <DeliveryPostalCode>sample string 14</DeliveryPostalCode> <DeliveryStateProvID>sample string 13</DeliveryStateProvID> <EndDate>sample string 3</EndDate> <InvoiceNumber>sample string 6</InvoiceNumber> <OrderStatus>sample string 7</OrderStatus> <PickupCityName>sample string 8</PickupCityName> <PickupCountryID>sample string 11</PickupCountryID> <PickupPostalCode>sample string 10</PickupPostalCode> <PickupStateProvID>sample string 9</PickupStateProvID> <Reference>sample string 16</Reference> <Reference2>sample string 17</Reference2> <Reference3>sample string 18</Reference3> <Reference4>sample string 19</Reference4> <Reference5>sample string 20</Reference5> <StartDate>sample string 2</StartDate> <TrackingNumber>sample string 5</TrackingNumber> <UserGUID>sample string 1</UserGUID> </SearchOrdersParm>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
SearchOrdersRespName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Method call was successful (true) or failed (false) |
boolean |
None. |
ErrorMessage |
Error message if method call failed for any reason |
string |
None. |
Orders |
The list of orders returned from the search criteria |
Collection of OrderItem |
None. |
Response Formats
application/json, text/json
{ "ErrorMessage": "sample string 2", "IsSuccessful": true, "Orders": [ { "AccountNumber": "sample string 1", "ActualPickupArrival": "sample string 74", "ActualPickupArrivalUTC": "sample string 75", "BaseCharge": "sample string 54", "CalledInBy": "sample string 51", "Contents": "sample string 50", "DeliveryAddress1": "sample string 15", "DeliveryAddress2": "sample string 16", "DeliveryAddress3": "sample string 17", "DeliveryAddressCode": "sample string 49", "DeliveryAttemptCharge": "sample string 63", "DeliveryAttempts": "sample string 42", "DeliveryCityName": "sample string 18", "DeliveryCompanyName": "sample string 14", "DeliveryContact": "sample string 22", "DeliveryCountryID": "sample string 21", "DeliveryDistance": "sample string 46", "DeliveryMileageCharge": "sample string 62", "DeliveryPostalCode": "sample string 20", "DeliveryStateProvID": "sample string 19", "DeliveryWaitingCharge": "sample string 64", "DeliveryWaitingMinutes": "sample string 44", "DeliveryWeekendCharge": "sample string 65", "DestinationAirportCode": "sample string 70", "DistanceUOM": "sample string 47", "FuelCharge": "sample string 56", "HoldAndDeliver": "sample string 66", "InvoiceList": "sample string 77", "OfficeCode": "sample string 4", "OrderDateTime": "sample string 2", "OriginAirportCode": "sample string 69", "OtherCharge": "sample string 68", "PODDateTime": "sample string 37", "PODDateTimeUTC": "sample string 38", "PODName": "sample string 36", "PickupAddress1": "sample string 6", "PickupAddress2": "sample string 7", "PickupAddress3": "sample string 8", "PickupAddressCode": "sample string 48", "PickupAttemptCharge": "sample string 59", "PickupAttempts": "sample string 41", "PickupCityName": "sample string 9", "PickupCompanyName": "sample string 5", "PickupContact": "sample string 13", "PickupCountryID": "sample string 12", "PickupDistance": "sample string 45", "PickupMileageCharge": "sample string 58", "PickupPostalCode": "sample string 11", "PickupStateProvID": "sample string 10", "PickupWaitingCharge": "sample string 60", "PickupWaitingMinutes": "sample string 43", "PickupWeekendCharge": "sample string 61", "Pieces": "sample string 32", "QuotedDeliveryDateTime": "sample string 39", "QuotedDeliveryDateTimeUTC": "sample string 40", "Reference": "sample string 23", "Reference2": "sample string 24", "Reference3": "sample string 25", "Reference4": "sample string 26", "Reference5": "sample string 27", "Reference6": "sample string 28", "Reference7": "sample string 29", "Reference8": "sample string 30", "Reference9": "sample string 31", "Routing": "sample string 76", "SecurityCharge": "sample string 57", "SecurityScreeningCharge": "sample string 67", "ServiceID": "sample string 52", "ShipmentGUID": "sample string 78", "ShipmentNumber": "sample string 79", "Status": "sample string 35", "TotalCharges": "sample string 53", "TotalDistance": "sample string 71", "TrackingNumber": "sample string 3", "UpdatedPickupDateTime": "sample string 72", "UpdatedPickupDateTimeUTC": "sample string 73", "Weight": "sample string 33", "WeightCharge": "sample string 55", "WeightUOM": "sample string 34" }, { "AccountNumber": "sample string 1", "ActualPickupArrival": "sample string 74", "ActualPickupArrivalUTC": "sample string 75", "BaseCharge": "sample string 54", "CalledInBy": "sample string 51", "Contents": "sample string 50", "DeliveryAddress1": "sample string 15", "DeliveryAddress2": "sample string 16", "DeliveryAddress3": "sample string 17", "DeliveryAddressCode": "sample string 49", "DeliveryAttemptCharge": "sample string 63", "DeliveryAttempts": "sample string 42", "DeliveryCityName": "sample string 18", "DeliveryCompanyName": "sample string 14", "DeliveryContact": "sample string 22", "DeliveryCountryID": "sample string 21", "DeliveryDistance": "sample string 46", "DeliveryMileageCharge": "sample string 62", "DeliveryPostalCode": "sample string 20", "DeliveryStateProvID": "sample string 19", "DeliveryWaitingCharge": "sample string 64", "DeliveryWaitingMinutes": "sample string 44", "DeliveryWeekendCharge": "sample string 65", "DestinationAirportCode": "sample string 70", "DistanceUOM": "sample string 47", "FuelCharge": "sample string 56", "HoldAndDeliver": "sample string 66", "InvoiceList": "sample string 77", "OfficeCode": "sample string 4", "OrderDateTime": "sample string 2", "OriginAirportCode": "sample string 69", "OtherCharge": "sample string 68", "PODDateTime": "sample string 37", "PODDateTimeUTC": "sample string 38", "PODName": "sample string 36", "PickupAddress1": "sample string 6", "PickupAddress2": "sample string 7", "PickupAddress3": "sample string 8", "PickupAddressCode": "sample string 48", "PickupAttemptCharge": "sample string 59", "PickupAttempts": "sample string 41", "PickupCityName": "sample string 9", "PickupCompanyName": "sample string 5", "PickupContact": "sample string 13", "PickupCountryID": "sample string 12", "PickupDistance": "sample string 45", "PickupMileageCharge": "sample string 58", "PickupPostalCode": "sample string 11", "PickupStateProvID": "sample string 10", "PickupWaitingCharge": "sample string 60", "PickupWaitingMinutes": "sample string 43", "PickupWeekendCharge": "sample string 61", "Pieces": "sample string 32", "QuotedDeliveryDateTime": "sample string 39", "QuotedDeliveryDateTimeUTC": "sample string 40", "Reference": "sample string 23", "Reference2": "sample string 24", "Reference3": "sample string 25", "Reference4": "sample string 26", "Reference5": "sample string 27", "Reference6": "sample string 28", "Reference7": "sample string 29", "Reference8": "sample string 30", "Reference9": "sample string 31", "Routing": "sample string 76", "SecurityCharge": "sample string 57", "SecurityScreeningCharge": "sample string 67", "ServiceID": "sample string 52", "ShipmentGUID": "sample string 78", "ShipmentNumber": "sample string 79", "Status": "sample string 35", "TotalCharges": "sample string 53", "TotalDistance": "sample string 71", "TrackingNumber": "sample string 3", "UpdatedPickupDateTime": "sample string 72", "UpdatedPickupDateTimeUTC": "sample string 73", "Weight": "sample string 33", "WeightCharge": "sample string 55", "WeightUOM": "sample string 34" } ] }
application/xml, text/xml
<SearchOrdersResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> <Orders> <OrderItem> <AccountNumber>sample string 1</AccountNumber> <ActualPickupArrival>sample string 74</ActualPickupArrival> <ActualPickupArrivalUTC>sample string 75</ActualPickupArrivalUTC> <BaseCharge>sample string 54</BaseCharge> <CalledInBy>sample string 51</CalledInBy> <Contents>sample string 50</Contents> <DeliveryAddress1>sample string 15</DeliveryAddress1> <DeliveryAddress2>sample string 16</DeliveryAddress2> <DeliveryAddress3>sample string 17</DeliveryAddress3> <DeliveryAddressCode>sample string 49</DeliveryAddressCode> <DeliveryAttemptCharge>sample string 63</DeliveryAttemptCharge> <DeliveryAttempts>sample string 42</DeliveryAttempts> <DeliveryCityName>sample string 18</DeliveryCityName> <DeliveryCompanyName>sample string 14</DeliveryCompanyName> <DeliveryContact>sample string 22</DeliveryContact> <DeliveryCountryID>sample string 21</DeliveryCountryID> <DeliveryDistance>sample string 46</DeliveryDistance> <DeliveryMileageCharge>sample string 62</DeliveryMileageCharge> <DeliveryPostalCode>sample string 20</DeliveryPostalCode> <DeliveryStateProvID>sample string 19</DeliveryStateProvID> <DeliveryWaitingCharge>sample string 64</DeliveryWaitingCharge> <DeliveryWaitingMinutes>sample string 44</DeliveryWaitingMinutes> <DeliveryWeekendCharge>sample string 65</DeliveryWeekendCharge> <DestinationAirportCode>sample string 70</DestinationAirportCode> <DistanceUOM>sample string 47</DistanceUOM> <FuelCharge>sample string 56</FuelCharge> <HoldAndDeliver>sample string 66</HoldAndDeliver> <InvoiceList>sample string 77</InvoiceList> <OfficeCode>sample string 4</OfficeCode> <OrderDateTime>sample string 2</OrderDateTime> <OriginAirportCode>sample string 69</OriginAirportCode> <OtherCharge>sample string 68</OtherCharge> <PODDateTime>sample string 37</PODDateTime> <PODDateTimeUTC>sample string 38</PODDateTimeUTC> <PODName>sample string 36</PODName> <PickupAddress1>sample string 6</PickupAddress1> <PickupAddress2>sample string 7</PickupAddress2> <PickupAddress3>sample string 8</PickupAddress3> <PickupAddressCode>sample string 48</PickupAddressCode> <PickupAttemptCharge>sample string 59</PickupAttemptCharge> <PickupAttempts>sample string 41</PickupAttempts> <PickupCityName>sample string 9</PickupCityName> <PickupCompanyName>sample string 5</PickupCompanyName> <PickupContact>sample string 13</PickupContact> <PickupCountryID>sample string 12</PickupCountryID> <PickupDistance>sample string 45</PickupDistance> <PickupMileageCharge>sample string 58</PickupMileageCharge> <PickupPostalCode>sample string 11</PickupPostalCode> <PickupStateProvID>sample string 10</PickupStateProvID> <PickupWaitingCharge>sample string 60</PickupWaitingCharge> <PickupWaitingMinutes>sample string 43</PickupWaitingMinutes> <PickupWeekendCharge>sample string 61</PickupWeekendCharge> <Pieces>sample string 32</Pieces> <QuotedDeliveryDateTime>sample string 39</QuotedDeliveryDateTime> <QuotedDeliveryDateTimeUTC>sample string 40</QuotedDeliveryDateTimeUTC> <Reference>sample string 23</Reference> <Reference2>sample string 24</Reference2> <Reference3>sample string 25</Reference3> <Reference4>sample string 26</Reference4> <Reference5>sample string 27</Reference5> <Reference6>sample string 28</Reference6> <Reference7>sample string 29</Reference7> <Reference8>sample string 30</Reference8> <Reference9>sample string 31</Reference9> <Routing>sample string 76</Routing> <SecurityCharge>sample string 57</SecurityCharge> <SecurityScreeningCharge>sample string 67</SecurityScreeningCharge> <ServiceID>sample string 52</ServiceID> <ShipmentGUID>sample string 78</ShipmentGUID> <ShipmentNumber>sample string 79</ShipmentNumber> <Status>sample string 35</Status> <TotalCharges>sample string 53</TotalCharges> <TotalDistance>sample string 71</TotalDistance> <TrackingNumber>sample string 3</TrackingNumber> <UpdatedPickupDateTime>sample string 72</UpdatedPickupDateTime> <UpdatedPickupDateTimeUTC>sample string 73</UpdatedPickupDateTimeUTC> <Weight>sample string 33</Weight> <WeightCharge>sample string 55</WeightCharge> <WeightUOM>sample string 34</WeightUOM> </OrderItem> <OrderItem> <AccountNumber>sample string 1</AccountNumber> <ActualPickupArrival>sample string 74</ActualPickupArrival> <ActualPickupArrivalUTC>sample string 75</ActualPickupArrivalUTC> <BaseCharge>sample string 54</BaseCharge> <CalledInBy>sample string 51</CalledInBy> <Contents>sample string 50</Contents> <DeliveryAddress1>sample string 15</DeliveryAddress1> <DeliveryAddress2>sample string 16</DeliveryAddress2> <DeliveryAddress3>sample string 17</DeliveryAddress3> <DeliveryAddressCode>sample string 49</DeliveryAddressCode> <DeliveryAttemptCharge>sample string 63</DeliveryAttemptCharge> <DeliveryAttempts>sample string 42</DeliveryAttempts> <DeliveryCityName>sample string 18</DeliveryCityName> <DeliveryCompanyName>sample string 14</DeliveryCompanyName> <DeliveryContact>sample string 22</DeliveryContact> <DeliveryCountryID>sample string 21</DeliveryCountryID> <DeliveryDistance>sample string 46</DeliveryDistance> <DeliveryMileageCharge>sample string 62</DeliveryMileageCharge> <DeliveryPostalCode>sample string 20</DeliveryPostalCode> <DeliveryStateProvID>sample string 19</DeliveryStateProvID> <DeliveryWaitingCharge>sample string 64</DeliveryWaitingCharge> <DeliveryWaitingMinutes>sample string 44</DeliveryWaitingMinutes> <DeliveryWeekendCharge>sample string 65</DeliveryWeekendCharge> <DestinationAirportCode>sample string 70</DestinationAirportCode> <DistanceUOM>sample string 47</DistanceUOM> <FuelCharge>sample string 56</FuelCharge> <HoldAndDeliver>sample string 66</HoldAndDeliver> <InvoiceList>sample string 77</InvoiceList> <OfficeCode>sample string 4</OfficeCode> <OrderDateTime>sample string 2</OrderDateTime> <OriginAirportCode>sample string 69</OriginAirportCode> <OtherCharge>sample string 68</OtherCharge> <PODDateTime>sample string 37</PODDateTime> <PODDateTimeUTC>sample string 38</PODDateTimeUTC> <PODName>sample string 36</PODName> <PickupAddress1>sample string 6</PickupAddress1> <PickupAddress2>sample string 7</PickupAddress2> <PickupAddress3>sample string 8</PickupAddress3> <PickupAddressCode>sample string 48</PickupAddressCode> <PickupAttemptCharge>sample string 59</PickupAttemptCharge> <PickupAttempts>sample string 41</PickupAttempts> <PickupCityName>sample string 9</PickupCityName> <PickupCompanyName>sample string 5</PickupCompanyName> <PickupContact>sample string 13</PickupContact> <PickupCountryID>sample string 12</PickupCountryID> <PickupDistance>sample string 45</PickupDistance> <PickupMileageCharge>sample string 58</PickupMileageCharge> <PickupPostalCode>sample string 11</PickupPostalCode> <PickupStateProvID>sample string 10</PickupStateProvID> <PickupWaitingCharge>sample string 60</PickupWaitingCharge> <PickupWaitingMinutes>sample string 43</PickupWaitingMinutes> <PickupWeekendCharge>sample string 61</PickupWeekendCharge> <Pieces>sample string 32</Pieces> <QuotedDeliveryDateTime>sample string 39</QuotedDeliveryDateTime> <QuotedDeliveryDateTimeUTC>sample string 40</QuotedDeliveryDateTimeUTC> <Reference>sample string 23</Reference> <Reference2>sample string 24</Reference2> <Reference3>sample string 25</Reference3> <Reference4>sample string 26</Reference4> <Reference5>sample string 27</Reference5> <Reference6>sample string 28</Reference6> <Reference7>sample string 29</Reference7> <Reference8>sample string 30</Reference8> <Reference9>sample string 31</Reference9> <Routing>sample string 76</Routing> <SecurityCharge>sample string 57</SecurityCharge> <SecurityScreeningCharge>sample string 67</SecurityScreeningCharge> <ServiceID>sample string 52</ServiceID> <ShipmentGUID>sample string 78</ShipmentGUID> <ShipmentNumber>sample string 79</ShipmentNumber> <Status>sample string 35</Status> <TotalCharges>sample string 53</TotalCharges> <TotalDistance>sample string 71</TotalDistance> <TrackingNumber>sample string 3</TrackingNumber> <UpdatedPickupDateTime>sample string 72</UpdatedPickupDateTime> <UpdatedPickupDateTimeUTC>sample string 73</UpdatedPickupDateTimeUTC> <Weight>sample string 33</Weight> <WeightCharge>sample string 55</WeightCharge> <WeightUOM>sample string 34</WeightUOM> </OrderItem> </Orders> </SearchOrdersResp>