POST api/ActiveOrders

Use this method to retrieve a list of active orders

Request Information

URI Parameters

None.

Body Parameters

ActiveOrderParm
NameDescriptionTypeAdditional information
auth

Authorization token

 string

None.
AccountNumber

(optional) Account number to filter log

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "AccountNumber": "sample string 2",
  "auth": "sample string 1"
}

application/xml, text/xml

Sample: 
<ActiveOrderParm 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>
  <auth>sample string 1</auth>
</ActiveOrderParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ActiveOrderResp
NameDescriptionTypeAdditional 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.
Orders

List of active orders

 Collection of ActiveOrderItem

None.

Response Formats

application/json, text/json

Sample: 
{
  "ErrorMessage": "sample string 2",
  "IsSuccessful": true,
  "Orders": [
    {
      "ActualDepartDateTime": "2024-09-20T20:32:28.266-07:00",
      "ActualPickupDateTime": "2024-09-20T20:32:28.266-07:00",
      "ArriveDateTime": "2024-09-20T20:32:28.266-07:00",
      "Contents": "sample string 10",
      "DeliveryAddress1": "sample string 20",
      "DeliveryAddress2": "sample string 21",
      "DeliveryAddress3": "sample string 22",
      "DeliveryAddressFull": "sample string 35",
      "DeliveryCityName": "sample string 23",
      "DeliveryCompanyName": "sample string 19",
      "DeliveryCountryID": "sample string 26",
      "DeliveryPostalCode": "sample string 25",
      "DeliveryStateProvID": "sample string 24",
      "DisplayDeliveryAddress": "sample string 31",
      "DisplayPickupAddress": "sample string 30",
      "DropAirportID": "sample string 37",
      "EstimatedDeliveryDateTime": "2024-09-20T20:32:28.266-07:00",
      "EstimatedDepartDateTime": "2024-09-20T20:32:28.266-07:00",
      "EstimatedPickupDateTime": "2024-09-20T20:32:28.266-07:00",
      "HasCustomerNotes": true,
      "HasGPSDevice": true,
      "OrderByName": "sample string 8",
      "OrderDate": "2024-09-20T20:32:28.265-07:00",
      "OrderState": "sample string 5",
      "OrderStatus": 4,
      "OrderStatusDisplay": "sample string 6",
      "PickupAddress1": "sample string 12",
      "PickupAddress2": "sample string 13",
      "PickupAddress3": "sample string 14",
      "PickupAddressFull": "sample string 34",
      "PickupCityName": "sample string 15",
      "PickupCompanyName": "sample string 11",
      "PickupCountryID": "sample string 18",
      "PickupPostalCode": "sample string 17",
      "PickupStateProvID": "sample string 16",
      "RecoverAirportID": "sample string 27",
      "Reference": "sample string 9",
      "RouteNumber": "sample string 29",
      "ServiceCode": "sample string 39",
      "ServiceName": "sample string 38",
      "ShipmentGUID": "sample string 1",
      "ShipmentNumber": 2,
      "TrackingNumber": "sample string 7",
      "TrackingUrl": "sample string 32",
      "TransportationMode": "sample string 42",
      "UpdatedDeliveryDateTime": "2024-09-20T20:32:28.266-07:00",
      "UpdatedDeliveryDateTimeDisplay": "sample string 33",
      "UpdatedDeliveryDateTimeUTC": "2024-09-20T20:32:28.266-07:00",
      "WaybillNumber": "sample string 28"
    },
    {
      "ActualDepartDateTime": "2024-09-20T20:32:28.266-07:00",
      "ActualPickupDateTime": "2024-09-20T20:32:28.266-07:00",
      "ArriveDateTime": "2024-09-20T20:32:28.266-07:00",
      "Contents": "sample string 10",
      "DeliveryAddress1": "sample string 20",
      "DeliveryAddress2": "sample string 21",
      "DeliveryAddress3": "sample string 22",
      "DeliveryAddressFull": "sample string 35",
      "DeliveryCityName": "sample string 23",
      "DeliveryCompanyName": "sample string 19",
      "DeliveryCountryID": "sample string 26",
      "DeliveryPostalCode": "sample string 25",
      "DeliveryStateProvID": "sample string 24",
      "DisplayDeliveryAddress": "sample string 31",
      "DisplayPickupAddress": "sample string 30",
      "DropAirportID": "sample string 37",
      "EstimatedDeliveryDateTime": "2024-09-20T20:32:28.266-07:00",
      "EstimatedDepartDateTime": "2024-09-20T20:32:28.266-07:00",
      "EstimatedPickupDateTime": "2024-09-20T20:32:28.266-07:00",
      "HasCustomerNotes": true,
      "HasGPSDevice": true,
      "OrderByName": "sample string 8",
      "OrderDate": "2024-09-20T20:32:28.265-07:00",
      "OrderState": "sample string 5",
      "OrderStatus": 4,
      "OrderStatusDisplay": "sample string 6",
      "PickupAddress1": "sample string 12",
      "PickupAddress2": "sample string 13",
      "PickupAddress3": "sample string 14",
      "PickupAddressFull": "sample string 34",
      "PickupCityName": "sample string 15",
      "PickupCompanyName": "sample string 11",
      "PickupCountryID": "sample string 18",
      "PickupPostalCode": "sample string 17",
      "PickupStateProvID": "sample string 16",
      "RecoverAirportID": "sample string 27",
      "Reference": "sample string 9",
      "RouteNumber": "sample string 29",
      "ServiceCode": "sample string 39",
      "ServiceName": "sample string 38",
      "ShipmentGUID": "sample string 1",
      "ShipmentNumber": 2,
      "TrackingNumber": "sample string 7",
      "TrackingUrl": "sample string 32",
      "TransportationMode": "sample string 42",
      "UpdatedDeliveryDateTime": "2024-09-20T20:32:28.266-07:00",
      "UpdatedDeliveryDateTimeDisplay": "sample string 33",
      "UpdatedDeliveryDateTimeUTC": "2024-09-20T20:32:28.266-07:00",
      "WaybillNumber": "sample string 28"
    }
  ]
}

application/xml, text/xml

Sample: 
<ActiveOrderResp 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>
    <ActiveOrderItem>
      <ActualDepartDateTime>2024-09-20T20:32:28.2660237-07:00</ActualDepartDateTime>
      <ActualPickupDateTime>2024-09-20T20:32:28.2660237-07:00</ActualPickupDateTime>
      <ArriveDateTime>2024-09-20T20:32:28.2660237-07:00</ArriveDateTime>
      <Contents>sample string 10</Contents>
      <DeliveryAddress1>sample string 20</DeliveryAddress1>
      <DeliveryAddress2>sample string 21</DeliveryAddress2>
      <DeliveryAddress3>sample string 22</DeliveryAddress3>
      <DeliveryAddressFull>sample string 35</DeliveryAddressFull>
      <DeliveryCityName>sample string 23</DeliveryCityName>
      <DeliveryCompanyName>sample string 19</DeliveryCompanyName>
      <DeliveryCountryID>sample string 26</DeliveryCountryID>
      <DeliveryPostalCode>sample string 25</DeliveryPostalCode>
      <DeliveryStateProvID>sample string 24</DeliveryStateProvID>
      <DisplayDeliveryAddress>sample string 31</DisplayDeliveryAddress>
      <DisplayPickupAddress>sample string 30</DisplayPickupAddress>
      <DropAirportID>sample string 37</DropAirportID>
      <EstimatedDeliveryDateTime>2024-09-20T20:32:28.2660237-07:00</EstimatedDeliveryDateTime>
      <EstimatedDepartDateTime>2024-09-20T20:32:28.2660237-07:00</EstimatedDepartDateTime>
      <EstimatedPickupDateTime>2024-09-20T20:32:28.2660237-07:00</EstimatedPickupDateTime>
      <HasCustomerNotes>true</HasCustomerNotes>
      <HasGPSDevice>true</HasGPSDevice>
      <OrderByName>sample string 8</OrderByName>
      <OrderDate>2024-09-20T20:32:28.2650297-07:00</OrderDate>
      <OrderState>sample string 5</OrderState>
      <OrderStatus>4</OrderStatus>
      <OrderStatusDisplay>sample string 6</OrderStatusDisplay>
      <PickupAddress1>sample string 12</PickupAddress1>
      <PickupAddress2>sample string 13</PickupAddress2>
      <PickupAddress3>sample string 14</PickupAddress3>
      <PickupAddressFull>sample string 34</PickupAddressFull>
      <PickupCityName>sample string 15</PickupCityName>
      <PickupCompanyName>sample string 11</PickupCompanyName>
      <PickupCountryID>sample string 18</PickupCountryID>
      <PickupPostalCode>sample string 17</PickupPostalCode>
      <PickupStateProvID>sample string 16</PickupStateProvID>
      <RecoverAirportID>sample string 27</RecoverAirportID>
      <Reference>sample string 9</Reference>
      <RouteNumber>sample string 29</RouteNumber>
      <ServiceCode>sample string 39</ServiceCode>
      <ServiceName>sample string 38</ServiceName>
      <ShipmentGUID>sample string 1</ShipmentGUID>
      <ShipmentNumber>2</ShipmentNumber>
      <TrackingNumber>sample string 7</TrackingNumber>
      <TrackingUrl>sample string 32</TrackingUrl>
      <TransportationMode>sample string 42</TransportationMode>
      <UpdatedDeliveryDateTime>2024-09-20T20:32:28.2660237-07:00</UpdatedDeliveryDateTime>
      <UpdatedDeliveryDateTimeDisplay>sample string 33</UpdatedDeliveryDateTimeDisplay>
      <UpdatedDeliveryDateTimeUTC>2024-09-20T20:32:28.2660237-07:00</UpdatedDeliveryDateTimeUTC>
      <WaybillNumber>sample string 28</WaybillNumber>
    </ActiveOrderItem>
    <ActiveOrderItem>
      <ActualDepartDateTime>2024-09-20T20:32:28.2660237-07:00</ActualDepartDateTime>
      <ActualPickupDateTime>2024-09-20T20:32:28.2660237-07:00</ActualPickupDateTime>
      <ArriveDateTime>2024-09-20T20:32:28.2660237-07:00</ArriveDateTime>
      <Contents>sample string 10</Contents>
      <DeliveryAddress1>sample string 20</DeliveryAddress1>
      <DeliveryAddress2>sample string 21</DeliveryAddress2>
      <DeliveryAddress3>sample string 22</DeliveryAddress3>
      <DeliveryAddressFull>sample string 35</DeliveryAddressFull>
      <DeliveryCityName>sample string 23</DeliveryCityName>
      <DeliveryCompanyName>sample string 19</DeliveryCompanyName>
      <DeliveryCountryID>sample string 26</DeliveryCountryID>
      <DeliveryPostalCode>sample string 25</DeliveryPostalCode>
      <DeliveryStateProvID>sample string 24</DeliveryStateProvID>
      <DisplayDeliveryAddress>sample string 31</DisplayDeliveryAddress>
      <DisplayPickupAddress>sample string 30</DisplayPickupAddress>
      <DropAirportID>sample string 37</DropAirportID>
      <EstimatedDeliveryDateTime>2024-09-20T20:32:28.2660237-07:00</EstimatedDeliveryDateTime>
      <EstimatedDepartDateTime>2024-09-20T20:32:28.2660237-07:00</EstimatedDepartDateTime>
      <EstimatedPickupDateTime>2024-09-20T20:32:28.2660237-07:00</EstimatedPickupDateTime>
      <HasCustomerNotes>true</HasCustomerNotes>
      <HasGPSDevice>true</HasGPSDevice>
      <OrderByName>sample string 8</OrderByName>
      <OrderDate>2024-09-20T20:32:28.2650297-07:00</OrderDate>
      <OrderState>sample string 5</OrderState>
      <OrderStatus>4</OrderStatus>
      <OrderStatusDisplay>sample string 6</OrderStatusDisplay>
      <PickupAddress1>sample string 12</PickupAddress1>
      <PickupAddress2>sample string 13</PickupAddress2>
      <PickupAddress3>sample string 14</PickupAddress3>
      <PickupAddressFull>sample string 34</PickupAddressFull>
      <PickupCityName>sample string 15</PickupCityName>
      <PickupCompanyName>sample string 11</PickupCompanyName>
      <PickupCountryID>sample string 18</PickupCountryID>
      <PickupPostalCode>sample string 17</PickupPostalCode>
      <PickupStateProvID>sample string 16</PickupStateProvID>
      <RecoverAirportID>sample string 27</RecoverAirportID>
      <Reference>sample string 9</Reference>
      <RouteNumber>sample string 29</RouteNumber>
      <ServiceCode>sample string 39</ServiceCode>
      <ServiceName>sample string 38</ServiceName>
      <ShipmentGUID>sample string 1</ShipmentGUID>
      <ShipmentNumber>2</ShipmentNumber>
      <TrackingNumber>sample string 7</TrackingNumber>
      <TrackingUrl>sample string 32</TrackingUrl>
      <TransportationMode>sample string 42</TransportationMode>
      <UpdatedDeliveryDateTime>2024-09-20T20:32:28.2660237-07:00</UpdatedDeliveryDateTime>
      <UpdatedDeliveryDateTimeDisplay>sample string 33</UpdatedDeliveryDateTimeDisplay>
      <UpdatedDeliveryDateTimeUTC>2024-09-20T20:32:28.2660237-07:00</UpdatedDeliveryDateTimeUTC>
      <WaybillNumber>sample string 28</WaybillNumber>
    </ActiveOrderItem>
  </Orders>
</ActiveOrderResp>