POST api/Search

Use this method to search orders in shipper web portal

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
auth	Authentication token	string	None.
AccountNumber	Account number to search or blank for all accounts assigned to shipper	string	None.
StartDate	Start date of the search (yyyy-MM-dd)	string	None.
EndDate	End date of the search (yyyy-MM-dd)	string	None.
TrackingNumber		string	None.
Contents		string	None.
Reference		string	None.
Reference2		string	None.
Reference3		string	None.
Reference4		string	None.
Reference5		string	None.
PickupStateProvID		string	None.
PickupCityName		string	None.
PickupPostalCode		string	None.
PickupCountryID		string	None.
DeliveryCityName		string	None.
DeliveryStateProvID		string	None.
DeliveryPostalCode		string	None.
DeliveryCountryID		string	None.
InvoiceNumber		integer	None.
OrderStatus	ANY=any status(ordered or cancelled), ORD=ordered, ACT=active orders (not delivered), DEL=delivered orders, BIL=billed orders	string	None.
CalledInBy		string	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountNumber": "sample string 2",
  "CalledInBy": "sample string 21",
  "Contents": "sample string 6",
  "DeliveryCityName": "sample string 16",
  "DeliveryCountryID": "sample string 19",
  "DeliveryPostalCode": "sample string 18",
  "DeliveryStateProvID": "sample string 17",
  "EndDate": "sample string 4",
  "InvoiceNumber": 1,
  "OrderStatus": "sample string 20",
  "PickupCityName": "sample string 13",
  "PickupCountryID": "sample string 15",
  "PickupPostalCode": "sample string 14",
  "PickupStateProvID": "sample string 12",
  "Reference": "sample string 7",
  "Reference2": "sample string 8",
  "Reference3": "sample string 9",
  "Reference4": "sample string 10",
  "Reference5": "sample string 11",
  "StartDate": "sample string 3",
  "TrackingNumber": "sample string 5",
  "auth": "sample string 1"
}

application/xml, text/xml

Sample:

<SearchParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <AccountNumber>sample string 2</AccountNumber>
  <CalledInBy>sample string 21</CalledInBy>
  <Contents>sample string 6</Contents>
  <DeliveryCityName>sample string 16</DeliveryCityName>
  <DeliveryCountryID>sample string 19</DeliveryCountryID>
  <DeliveryPostalCode>sample string 18</DeliveryPostalCode>
  <DeliveryStateProvID>sample string 17</DeliveryStateProvID>
  <EndDate>sample string 4</EndDate>
  <InvoiceNumber>1</InvoiceNumber>
  <OrderStatus>sample string 20</OrderStatus>
  <PickupCityName>sample string 13</PickupCityName>
  <PickupCountryID>sample string 15</PickupCountryID>
  <PickupPostalCode>sample string 14</PickupPostalCode>
  <PickupStateProvID>sample string 12</PickupStateProvID>
  <Reference>sample string 7</Reference>
  <Reference2>sample string 8</Reference2>
  <Reference3>sample string 9</Reference3>
  <Reference4>sample string 10</Reference4>
  <Reference5>sample string 11</Reference5>
  <StartDate>sample string 3</StartDate>
  <TrackingNumber>sample string 5</TrackingNumber>
  <auth>sample string 1</auth>
</SearchParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResp

Name	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.
Items	List of items return based on search critiera	Collection of SearchItem	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorMessage": "sample string 2",
  "IsSuccessful": true,
  "Items": [
    {
      "AccountNumber": "sample string 1",
      "ActualPickupArrival": "sample string 58",
      "BaseCharge": 1,
      "CalledInBy": "sample string 44",
      "Contents": "sample string 43",
      "DeliveryAddress": "sample string 16",
      "DeliveryAddress1": "sample string 18",
      "DeliveryAddress2": "sample string 19",
      "DeliveryAddress3": "sample string 20",
      "DeliveryAddressCode": "sample string 42",
      "DeliveryAddressFull": "sample string 25",
      "DeliveryAttemptCharge": 1,
      "DeliveryAttempts": 1,
      "DeliveryCityName": "sample string 21",
      "DeliveryCompanyName": "sample string 17",
      "DeliveryContact": "sample string 26",
      "DeliveryCountryID": "sample string 24",
      "DeliveryDistance": 1,
      "DeliveryEmailAddress": "sample string 68",
      "DeliveryInstructions": "sample string 70",
      "DeliveryMileageCharge": 1,
      "DeliveryPhoneNumber": "sample string 67",
      "DeliveryPostalCode": "sample string 23",
      "DeliveryStateProvID": "sample string 22",
      "DeliveryWaitingCharge": 1,
      "DeliveryWaitingMinutes": 1,
      "DeliveryWeekendCharge": 1,
      "DestinationAirportCode": "sample string 47",
      "DistanceUOM": "sample string 40",
      "FuelCharge": 1,
      "HoldAndDeliver": 1,
      "InvoiceList": "sample string 60",
      "OfficeCode": "sample string 4",
      "OrderDateTime": "sample string 2",
      "OrderSource": "sample string 71",
      "OriginAirportCode": "sample string 46",
      "OtherCharge": 1,
      "PODDateTime": "sample string 36",
      "PODDateTimeUTC": "sample string 37",
      "PODName": "sample string 35",
      "PickupAddress": "sample string 5",
      "PickupAddress1": "sample string 8",
      "PickupAddress2": "sample string 9",
      "PickupAddress3": "sample string 10",
      "PickupAddressCode": "sample string 41",
      "PickupAddressFull": "sample string 6",
      "PickupAttemptCharge": 1,
      "PickupAttempts": 1,
      "PickupCityName": "sample string 11",
      "PickupCompanyName": "sample string 7",
      "PickupContact": "sample string 15",
      "PickupCountryID": "sample string 14",
      "PickupDistance": 1,
      "PickupEmailAddress": "sample string 66",
      "PickupInstructions": "sample string 69",
      "PickupMileageCharge": 1,
      "PickupPhoneNumber": "sample string 65",
      "PickupPostalCode": "sample string 13",
      "PickupStateProvID": "sample string 12",
      "PickupWaitingCharge": 1,
      "PickupWaitingMinutes": 1,
      "PickupWeekendCharge": 1,
      "Pieces": 32,
      "QuotedDeliveryDateTime": "sample string 38",
      "QuotedDeliveryDateTimeUTC": "sample string 39",
      "Reference": "sample string 27",
      "Reference2": "sample string 28",
      "Reference3": "sample string 29",
      "Reference4": "sample string 30",
      "Reference5": "sample string 31",
      "Reference6": "sample string 61",
      "Reference7": "sample string 62",
      "Reference8": "sample string 63",
      "Reference9": "sample string 64",
      "ReferenceValue_Type1": "sample string 50",
      "ReferenceValue_Type12": "sample string 54",
      "ReferenceValue_Type13": "sample string 55",
      "ReferenceValue_Type2": "sample string 51",
      "ReferenceValue_Type3": "sample string 52",
      "ReferenceValue_Type4": "sample string 53",
      "Routing": "sample string 59",
      "SecurityCharge": 1,
      "SecurityScreeningCharge": 1,
      "ServiceID": "sample string 45",
      "ShipmentGUID": "sample string 48",
      "ShipmentNumber": 1,
      "Status": "sample string 34",
      "TotalCharges": 1,
      "TotalDistance": 1,
      "TrackingNumber": "sample string 3",
      "TrackingUrl": "sample string 49",
      "UpdatedPickupDateTime": "sample string 56",
      "UpdatedPickupDateTimeUTC": "sample string 57",
      "Weight": 1,
      "WeightCharge": 1,
      "WeightUOM": "sample string 33"
    },
    {
      "AccountNumber": "sample string 1",
      "ActualPickupArrival": "sample string 58",
      "BaseCharge": 1,
      "CalledInBy": "sample string 44",
      "Contents": "sample string 43",
      "DeliveryAddress": "sample string 16",
      "DeliveryAddress1": "sample string 18",
      "DeliveryAddress2": "sample string 19",
      "DeliveryAddress3": "sample string 20",
      "DeliveryAddressCode": "sample string 42",
      "DeliveryAddressFull": "sample string 25",
      "DeliveryAttemptCharge": 1,
      "DeliveryAttempts": 1,
      "DeliveryCityName": "sample string 21",
      "DeliveryCompanyName": "sample string 17",
      "DeliveryContact": "sample string 26",
      "DeliveryCountryID": "sample string 24",
      "DeliveryDistance": 1,
      "DeliveryEmailAddress": "sample string 68",
      "DeliveryInstructions": "sample string 70",
      "DeliveryMileageCharge": 1,
      "DeliveryPhoneNumber": "sample string 67",
      "DeliveryPostalCode": "sample string 23",
      "DeliveryStateProvID": "sample string 22",
      "DeliveryWaitingCharge": 1,
      "DeliveryWaitingMinutes": 1,
      "DeliveryWeekendCharge": 1,
      "DestinationAirportCode": "sample string 47",
      "DistanceUOM": "sample string 40",
      "FuelCharge": 1,
      "HoldAndDeliver": 1,
      "InvoiceList": "sample string 60",
      "OfficeCode": "sample string 4",
      "OrderDateTime": "sample string 2",
      "OrderSource": "sample string 71",
      "OriginAirportCode": "sample string 46",
      "OtherCharge": 1,
      "PODDateTime": "sample string 36",
      "PODDateTimeUTC": "sample string 37",
      "PODName": "sample string 35",
      "PickupAddress": "sample string 5",
      "PickupAddress1": "sample string 8",
      "PickupAddress2": "sample string 9",
      "PickupAddress3": "sample string 10",
      "PickupAddressCode": "sample string 41",
      "PickupAddressFull": "sample string 6",
      "PickupAttemptCharge": 1,
      "PickupAttempts": 1,
      "PickupCityName": "sample string 11",
      "PickupCompanyName": "sample string 7",
      "PickupContact": "sample string 15",
      "PickupCountryID": "sample string 14",
      "PickupDistance": 1,
      "PickupEmailAddress": "sample string 66",
      "PickupInstructions": "sample string 69",
      "PickupMileageCharge": 1,
      "PickupPhoneNumber": "sample string 65",
      "PickupPostalCode": "sample string 13",
      "PickupStateProvID": "sample string 12",
      "PickupWaitingCharge": 1,
      "PickupWaitingMinutes": 1,
      "PickupWeekendCharge": 1,
      "Pieces": 32,
      "QuotedDeliveryDateTime": "sample string 38",
      "QuotedDeliveryDateTimeUTC": "sample string 39",
      "Reference": "sample string 27",
      "Reference2": "sample string 28",
      "Reference3": "sample string 29",
      "Reference4": "sample string 30",
      "Reference5": "sample string 31",
      "Reference6": "sample string 61",
      "Reference7": "sample string 62",
      "Reference8": "sample string 63",
      "Reference9": "sample string 64",
      "ReferenceValue_Type1": "sample string 50",
      "ReferenceValue_Type12": "sample string 54",
      "ReferenceValue_Type13": "sample string 55",
      "ReferenceValue_Type2": "sample string 51",
      "ReferenceValue_Type3": "sample string 52",
      "ReferenceValue_Type4": "sample string 53",
      "Routing": "sample string 59",
      "SecurityCharge": 1,
      "SecurityScreeningCharge": 1,
      "ServiceID": "sample string 45",
      "ShipmentGUID": "sample string 48",
      "ShipmentNumber": 1,
      "Status": "sample string 34",
      "TotalCharges": 1,
      "TotalDistance": 1,
      "TrackingNumber": "sample string 3",
      "TrackingUrl": "sample string 49",
      "UpdatedPickupDateTime": "sample string 56",
      "UpdatedPickupDateTimeUTC": "sample string 57",
      "Weight": 1,
      "WeightCharge": 1,
      "WeightUOM": "sample string 33"
    }
  ]
}

application/xml, text/xml

Sample:

<SearchResp 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>
  <Items>
    <SearchItem>
      <AccountNumber>sample string 1</AccountNumber>
      <ActualPickupArrival>sample string 58</ActualPickupArrival>
      <BaseCharge>1</BaseCharge>
      <CalledInBy>sample string 44</CalledInBy>
      <Contents>sample string 43</Contents>
      <DeliveryAddress>sample string 16</DeliveryAddress>
      <DeliveryAddress1>sample string 18</DeliveryAddress1>
      <DeliveryAddress2>sample string 19</DeliveryAddress2>
      <DeliveryAddress3>sample string 20</DeliveryAddress3>
      <DeliveryAddressCode>sample string 42</DeliveryAddressCode>
      <DeliveryAddressFull>sample string 25</DeliveryAddressFull>
      <DeliveryAttemptCharge>1</DeliveryAttemptCharge>
      <DeliveryAttempts>1</DeliveryAttempts>
      <DeliveryCityName>sample string 21</DeliveryCityName>
      <DeliveryCompanyName>sample string 17</DeliveryCompanyName>
      <DeliveryContact>sample string 26</DeliveryContact>
      <DeliveryCountryID>sample string 24</DeliveryCountryID>
      <DeliveryDistance>1</DeliveryDistance>
      <DeliveryEmailAddress>sample string 68</DeliveryEmailAddress>
      <DeliveryInstructions>sample string 70</DeliveryInstructions>
      <DeliveryMileageCharge>1</DeliveryMileageCharge>
      <DeliveryPhoneNumber>sample string 67</DeliveryPhoneNumber>
      <DeliveryPostalCode>sample string 23</DeliveryPostalCode>
      <DeliveryStateProvID>sample string 22</DeliveryStateProvID>
      <DeliveryWaitingCharge>1</DeliveryWaitingCharge>
      <DeliveryWaitingMinutes>1</DeliveryWaitingMinutes>
      <DeliveryWeekendCharge>1</DeliveryWeekendCharge>
      <DestinationAirportCode>sample string 47</DestinationAirportCode>
      <DistanceUOM>sample string 40</DistanceUOM>
      <FuelCharge>1</FuelCharge>
      <HoldAndDeliver>1</HoldAndDeliver>
      <InvoiceList>sample string 60</InvoiceList>
      <OfficeCode>sample string 4</OfficeCode>
      <OrderDateTime>sample string 2</OrderDateTime>
      <OrderSource>sample string 71</OrderSource>
      <OriginAirportCode>sample string 46</OriginAirportCode>
      <OtherCharge>1</OtherCharge>
      <PODDateTime>sample string 36</PODDateTime>
      <PODDateTimeUTC>sample string 37</PODDateTimeUTC>
      <PODName>sample string 35</PODName>
      <PickupAddress>sample string 5</PickupAddress>
      <PickupAddress1>sample string 8</PickupAddress1>
      <PickupAddress2>sample string 9</PickupAddress2>
      <PickupAddress3>sample string 10</PickupAddress3>
      <PickupAddressCode>sample string 41</PickupAddressCode>
      <PickupAddressFull>sample string 6</PickupAddressFull>
      <PickupAttemptCharge>1</PickupAttemptCharge>
      <PickupAttempts>1</PickupAttempts>
      <PickupCityName>sample string 11</PickupCityName>
      <PickupCompanyName>sample string 7</PickupCompanyName>
      <PickupContact>sample string 15</PickupContact>
      <PickupCountryID>sample string 14</PickupCountryID>
      <PickupDistance>1</PickupDistance>
      <PickupEmailAddress>sample string 66</PickupEmailAddress>
      <PickupInstructions>sample string 69</PickupInstructions>
      <PickupMileageCharge>1</PickupMileageCharge>
      <PickupPhoneNumber>sample string 65</PickupPhoneNumber>
      <PickupPostalCode>sample string 13</PickupPostalCode>
      <PickupStateProvID>sample string 12</PickupStateProvID>
      <PickupWaitingCharge>1</PickupWaitingCharge>
      <PickupWaitingMinutes>1</PickupWaitingMinutes>
      <PickupWeekendCharge>1</PickupWeekendCharge>
      <Pieces>32</Pieces>
      <QuotedDeliveryDateTime>sample string 38</QuotedDeliveryDateTime>
      <QuotedDeliveryDateTimeUTC>sample string 39</QuotedDeliveryDateTimeUTC>
      <Reference>sample string 27</Reference>
      <Reference2>sample string 28</Reference2>
      <Reference3>sample string 29</Reference3>
      <Reference4>sample string 30</Reference4>
      <Reference5>sample string 31</Reference5>
      <Reference6>sample string 61</Reference6>
      <Reference7>sample string 62</Reference7>
      <Reference8>sample string 63</Reference8>
      <Reference9>sample string 64</Reference9>
      <ReferenceValue_Type1>sample string 50</ReferenceValue_Type1>
      <ReferenceValue_Type12>sample string 54</ReferenceValue_Type12>
      <ReferenceValue_Type13>sample string 55</ReferenceValue_Type13>
      <ReferenceValue_Type2>sample string 51</ReferenceValue_Type2>
      <ReferenceValue_Type3>sample string 52</ReferenceValue_Type3>
      <ReferenceValue_Type4>sample string 53</ReferenceValue_Type4>
      <Routing>sample string 59</Routing>
      <SecurityCharge>1</SecurityCharge>
      <SecurityScreeningCharge>1</SecurityScreeningCharge>
      <ServiceID>sample string 45</ServiceID>
      <ShipmentGUID>sample string 48</ShipmentGUID>
      <ShipmentNumber>1</ShipmentNumber>
      <Status>sample string 34</Status>
      <TotalCharges>1</TotalCharges>
      <TotalDistance>1</TotalDistance>
      <TrackingNumber>sample string 3</TrackingNumber>
      <TrackingUrl>sample string 49</TrackingUrl>
      <UpdatedPickupDateTime>sample string 56</UpdatedPickupDateTime>
      <UpdatedPickupDateTimeUTC>sample string 57</UpdatedPickupDateTimeUTC>
      <Weight>1</Weight>
      <WeightCharge>1</WeightCharge>
      <WeightUOM>sample string 33</WeightUOM>
    </SearchItem>
    <SearchItem>
      <AccountNumber>sample string 1</AccountNumber>
      <ActualPickupArrival>sample string 58</ActualPickupArrival>
      <BaseCharge>1</BaseCharge>
      <CalledInBy>sample string 44</CalledInBy>
      <Contents>sample string 43</Contents>
      <DeliveryAddress>sample string 16</DeliveryAddress>
      <DeliveryAddress1>sample string 18</DeliveryAddress1>
      <DeliveryAddress2>sample string 19</DeliveryAddress2>
      <DeliveryAddress3>sample string 20</DeliveryAddress3>
      <DeliveryAddressCode>sample string 42</DeliveryAddressCode>
      <DeliveryAddressFull>sample string 25</DeliveryAddressFull>
      <DeliveryAttemptCharge>1</DeliveryAttemptCharge>
      <DeliveryAttempts>1</DeliveryAttempts>
      <DeliveryCityName>sample string 21</DeliveryCityName>
      <DeliveryCompanyName>sample string 17</DeliveryCompanyName>
      <DeliveryContact>sample string 26</DeliveryContact>
      <DeliveryCountryID>sample string 24</DeliveryCountryID>
      <DeliveryDistance>1</DeliveryDistance>
      <DeliveryEmailAddress>sample string 68</DeliveryEmailAddress>
      <DeliveryInstructions>sample string 70</DeliveryInstructions>
      <DeliveryMileageCharge>1</DeliveryMileageCharge>
      <DeliveryPhoneNumber>sample string 67</DeliveryPhoneNumber>
      <DeliveryPostalCode>sample string 23</DeliveryPostalCode>
      <DeliveryStateProvID>sample string 22</DeliveryStateProvID>
      <DeliveryWaitingCharge>1</DeliveryWaitingCharge>
      <DeliveryWaitingMinutes>1</DeliveryWaitingMinutes>
      <DeliveryWeekendCharge>1</DeliveryWeekendCharge>
      <DestinationAirportCode>sample string 47</DestinationAirportCode>
      <DistanceUOM>sample string 40</DistanceUOM>
      <FuelCharge>1</FuelCharge>
      <HoldAndDeliver>1</HoldAndDeliver>
      <InvoiceList>sample string 60</InvoiceList>
      <OfficeCode>sample string 4</OfficeCode>
      <OrderDateTime>sample string 2</OrderDateTime>
      <OrderSource>sample string 71</OrderSource>
      <OriginAirportCode>sample string 46</OriginAirportCode>
      <OtherCharge>1</OtherCharge>
      <PODDateTime>sample string 36</PODDateTime>
      <PODDateTimeUTC>sample string 37</PODDateTimeUTC>
      <PODName>sample string 35</PODName>
      <PickupAddress>sample string 5</PickupAddress>
      <PickupAddress1>sample string 8</PickupAddress1>
      <PickupAddress2>sample string 9</PickupAddress2>
      <PickupAddress3>sample string 10</PickupAddress3>
      <PickupAddressCode>sample string 41</PickupAddressCode>
      <PickupAddressFull>sample string 6</PickupAddressFull>
      <PickupAttemptCharge>1</PickupAttemptCharge>
      <PickupAttempts>1</PickupAttempts>
      <PickupCityName>sample string 11</PickupCityName>
      <PickupCompanyName>sample string 7</PickupCompanyName>
      <PickupContact>sample string 15</PickupContact>
      <PickupCountryID>sample string 14</PickupCountryID>
      <PickupDistance>1</PickupDistance>
      <PickupEmailAddress>sample string 66</PickupEmailAddress>
      <PickupInstructions>sample string 69</PickupInstructions>
      <PickupMileageCharge>1</PickupMileageCharge>
      <PickupPhoneNumber>sample string 65</PickupPhoneNumber>
      <PickupPostalCode>sample string 13</PickupPostalCode>
      <PickupStateProvID>sample string 12</PickupStateProvID>
      <PickupWaitingCharge>1</PickupWaitingCharge>
      <PickupWaitingMinutes>1</PickupWaitingMinutes>
      <PickupWeekendCharge>1</PickupWeekendCharge>
      <Pieces>32</Pieces>
      <QuotedDeliveryDateTime>sample string 38</QuotedDeliveryDateTime>
      <QuotedDeliveryDateTimeUTC>sample string 39</QuotedDeliveryDateTimeUTC>
      <Reference>sample string 27</Reference>
      <Reference2>sample string 28</Reference2>
      <Reference3>sample string 29</Reference3>
      <Reference4>sample string 30</Reference4>
      <Reference5>sample string 31</Reference5>
      <Reference6>sample string 61</Reference6>
      <Reference7>sample string 62</Reference7>
      <Reference8>sample string 63</Reference8>
      <Reference9>sample string 64</Reference9>
      <ReferenceValue_Type1>sample string 50</ReferenceValue_Type1>
      <ReferenceValue_Type12>sample string 54</ReferenceValue_Type12>
      <ReferenceValue_Type13>sample string 55</ReferenceValue_Type13>
      <ReferenceValue_Type2>sample string 51</ReferenceValue_Type2>
      <ReferenceValue_Type3>sample string 52</ReferenceValue_Type3>
      <ReferenceValue_Type4>sample string 53</ReferenceValue_Type4>
      <Routing>sample string 59</Routing>
      <SecurityCharge>1</SecurityCharge>
      <SecurityScreeningCharge>1</SecurityScreeningCharge>
      <ServiceID>sample string 45</ServiceID>
      <ShipmentGUID>sample string 48</ShipmentGUID>
      <ShipmentNumber>1</ShipmentNumber>
      <Status>sample string 34</Status>
      <TotalCharges>1</TotalCharges>
      <TotalDistance>1</TotalDistance>
      <TrackingNumber>sample string 3</TrackingNumber>
      <TrackingUrl>sample string 49</TrackingUrl>
      <UpdatedPickupDateTime>sample string 56</UpdatedPickupDateTime>
      <UpdatedPickupDateTimeUTC>sample string 57</UpdatedPickupDateTimeUTC>
      <Weight>1</Weight>
      <WeightCharge>1</WeightCharge>
      <WeightUOM>sample string 33</WeightUOM>
    </SearchItem>
  </Items>
</SearchResp>