GET api/Shipper/GetActiveOrders/{auth}/{AccountNumber}

Get active orders for user

Request Information

URI Parameters

NameDescriptionTypeAdditional information
auth

Unique authorization identifier

 string

Required
AccountNumber

The account number to filter the list

 string

Required

Body Parameters

None.

Response Information

Resource Description

ActiveOrderResp
NameDescriptionTypeAdditional information
IsSuccessful

Set to true if method was successful

 boolean

None.
ErrorMessage

The error message if method call was not successful

 string

None.
Orders

The list of active orders

 Collection of ActiveOrderItem

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Orders": [
    {
      "ShipmentGUID": "sample string 1",
      "OrderDateDisplay": "sample string 2",
      "ShipmentNumber": 3,
      "OrderDate": "2024-09-22T03:09:32.4237767-07:00",
      "OrderStatus": 5,
      "OrderState": "sample string 6",
      "OrderStatusDisplay": "sample string 7",
      "TrackingNumber": "sample string 8",
      "OrderByName": "sample string 9",
      "Reference": "sample string 10",
      "Contents": "sample string 11",
      "PickupCompanyName": "sample string 12",
      "PickupAddress1": "sample string 13",
      "PickupAddress2": "sample string 14",
      "PickupAddress3": "sample string 15",
      "PickupCityName": "sample string 16",
      "PickupStateProvID": "sample string 17",
      "PickupPostalCode": "sample string 18",
      "PickupCountryID": "sample string 19",
      "DeliveryCompanyName": "sample string 20",
      "DeliveryAddress1": "sample string 21",
      "DeliveryAddress2": "sample string 22",
      "DeliveryAddress3": "sample string 23",
      "DeliveryCityName": "sample string 24",
      "DeliveryStateProvID": "sample string 25",
      "DeliveryPostalCode": "sample string 26",
      "DeliveryCountryID": "sample string 27",
      "HoldForPickup": true,
      "RecoverAirportID": "sample string 29",
      "WaybillNumber": "sample string 30",
      "RouteNumber": "sample string 31",
      "ArriveDateTime": "2024-09-22T03:09:32.4247754-07:00",
      "DisplayPickupAddress": "sample string 16 sample string 19",
      "DisplayDeliveryAddress": "sample string 24 sample string 27",
      "UpdatedDeliveryDateTime": "2024-09-22T03:09:32.4247754-07:00",
      "UpdatedDeliveryDateTimeDisplay": "SUN SEP-22 03:09 AM",
      "PickupAddressFull": "sample string 12<br>sample string 13<br>sample string 14<br>sample string 15<br>sample string 16, sample string 17 sample string 18 sample string 19",
      "DeliveryAddressFull": "HOLD FOR PICKUP: sample string 29<br>MAWB#: sample string 30<br>FLIGHT: sample string 31<br>ARRIVE: SUN 22-SEP 03:09<br>sample string 24, sample string 25 sample string 26 sample string 27"
    },
    {
      "ShipmentGUID": "sample string 1",
      "OrderDateDisplay": "sample string 2",
      "ShipmentNumber": 3,
      "OrderDate": "2024-09-22T03:09:32.4237767-07:00",
      "OrderStatus": 5,
      "OrderState": "sample string 6",
      "OrderStatusDisplay": "sample string 7",
      "TrackingNumber": "sample string 8",
      "OrderByName": "sample string 9",
      "Reference": "sample string 10",
      "Contents": "sample string 11",
      "PickupCompanyName": "sample string 12",
      "PickupAddress1": "sample string 13",
      "PickupAddress2": "sample string 14",
      "PickupAddress3": "sample string 15",
      "PickupCityName": "sample string 16",
      "PickupStateProvID": "sample string 17",
      "PickupPostalCode": "sample string 18",
      "PickupCountryID": "sample string 19",
      "DeliveryCompanyName": "sample string 20",
      "DeliveryAddress1": "sample string 21",
      "DeliveryAddress2": "sample string 22",
      "DeliveryAddress3": "sample string 23",
      "DeliveryCityName": "sample string 24",
      "DeliveryStateProvID": "sample string 25",
      "DeliveryPostalCode": "sample string 26",
      "DeliveryCountryID": "sample string 27",
      "HoldForPickup": true,
      "RecoverAirportID": "sample string 29",
      "WaybillNumber": "sample string 30",
      "RouteNumber": "sample string 31",
      "ArriveDateTime": "2024-09-22T03:09:32.4247754-07:00",
      "DisplayPickupAddress": "sample string 16 sample string 19",
      "DisplayDeliveryAddress": "sample string 24 sample string 27",
      "UpdatedDeliveryDateTime": "2024-09-22T03:09:32.4247754-07:00",
      "UpdatedDeliveryDateTimeDisplay": "SUN SEP-22 03:09 AM",
      "PickupAddressFull": "sample string 12<br>sample string 13<br>sample string 14<br>sample string 15<br>sample string 16, sample string 17 sample string 18 sample string 19",
      "DeliveryAddressFull": "HOLD FOR PICKUP: sample string 29<br>MAWB#: sample string 30<br>FLIGHT: sample string 31<br>ARRIVE: SUN 22-SEP 03:09<br>sample string 24, sample string 25 sample string 26 sample string 27"
    }
  ]
}

application/xml, text/xml

Sample: 
<ActiveOrderResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Shipper">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <Orders>
    <ActiveOrderItem>
      <ArriveDateTime>2024-09-22T03:09:32.4247754-07:00</ArriveDateTime>
      <Contents>sample string 11</Contents>
      <DeliveryAddress1>sample string 21</DeliveryAddress1>
      <DeliveryAddress2>sample string 22</DeliveryAddress2>
      <DeliveryAddress3>sample string 23</DeliveryAddress3>
      <DeliveryCityName>sample string 24</DeliveryCityName>
      <DeliveryCompanyName>sample string 20</DeliveryCompanyName>
      <DeliveryCountryID>sample string 27</DeliveryCountryID>
      <DeliveryPostalCode>sample string 26</DeliveryPostalCode>
      <DeliveryStateProvID>sample string 25</DeliveryStateProvID>
      <HoldForPickup>true</HoldForPickup>
      <OrderByName>sample string 9</OrderByName>
      <OrderDate>2024-09-22T03:09:32.4237767-07:00</OrderDate>
      <OrderDateDisplay>sample string 2</OrderDateDisplay>
      <OrderState>sample string 6</OrderState>
      <OrderStatus>5</OrderStatus>
      <OrderStatusDisplay>sample string 7</OrderStatusDisplay>
      <PickupAddress1>sample string 13</PickupAddress1>
      <PickupAddress2>sample string 14</PickupAddress2>
      <PickupAddress3>sample string 15</PickupAddress3>
      <PickupCityName>sample string 16</PickupCityName>
      <PickupCompanyName>sample string 12</PickupCompanyName>
      <PickupCountryID>sample string 19</PickupCountryID>
      <PickupPostalCode>sample string 18</PickupPostalCode>
      <PickupStateProvID>sample string 17</PickupStateProvID>
      <RecoverAirportID>sample string 29</RecoverAirportID>
      <Reference>sample string 10</Reference>
      <RouteNumber>sample string 31</RouteNumber>
      <ShipmentGUID>sample string 1</ShipmentGUID>
      <ShipmentNumber>3</ShipmentNumber>
      <TrackingNumber>sample string 8</TrackingNumber>
      <UpdatedDeliveryDateTime>2024-09-22T03:09:32.4247754-07:00</UpdatedDeliveryDateTime>
      <WaybillNumber>sample string 30</WaybillNumber>
    </ActiveOrderItem>
    <ActiveOrderItem>
      <ArriveDateTime>2024-09-22T03:09:32.4247754-07:00</ArriveDateTime>
      <Contents>sample string 11</Contents>
      <DeliveryAddress1>sample string 21</DeliveryAddress1>
      <DeliveryAddress2>sample string 22</DeliveryAddress2>
      <DeliveryAddress3>sample string 23</DeliveryAddress3>
      <DeliveryCityName>sample string 24</DeliveryCityName>
      <DeliveryCompanyName>sample string 20</DeliveryCompanyName>
      <DeliveryCountryID>sample string 27</DeliveryCountryID>
      <DeliveryPostalCode>sample string 26</DeliveryPostalCode>
      <DeliveryStateProvID>sample string 25</DeliveryStateProvID>
      <HoldForPickup>true</HoldForPickup>
      <OrderByName>sample string 9</OrderByName>
      <OrderDate>2024-09-22T03:09:32.4237767-07:00</OrderDate>
      <OrderDateDisplay>sample string 2</OrderDateDisplay>
      <OrderState>sample string 6</OrderState>
      <OrderStatus>5</OrderStatus>
      <OrderStatusDisplay>sample string 7</OrderStatusDisplay>
      <PickupAddress1>sample string 13</PickupAddress1>
      <PickupAddress2>sample string 14</PickupAddress2>
      <PickupAddress3>sample string 15</PickupAddress3>
      <PickupCityName>sample string 16</PickupCityName>
      <PickupCompanyName>sample string 12</PickupCompanyName>
      <PickupCountryID>sample string 19</PickupCountryID>
      <PickupPostalCode>sample string 18</PickupPostalCode>
      <PickupStateProvID>sample string 17</PickupStateProvID>
      <RecoverAirportID>sample string 29</RecoverAirportID>
      <Reference>sample string 10</Reference>
      <RouteNumber>sample string 31</RouteNumber>
      <ShipmentGUID>sample string 1</ShipmentGUID>
      <ShipmentNumber>3</ShipmentNumber>
      <TrackingNumber>sample string 8</TrackingNumber>
      <UpdatedDeliveryDateTime>2024-09-22T03:09:32.4247754-07:00</UpdatedDeliveryDateTime>
      <WaybillNumber>sample string 30</WaybillNumber>
    </ActiveOrderItem>
  </Orders>
</ActiveOrderResp>