GET api/Track/GetActiveOrders/{UserGUID}
Used to retrieve the current active orders
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
UserGUID |
Unique system generated user identifier |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
ActiveOrdersRespName | Description | Type | Additional information |
---|---|---|---|
ActiveOrders |
List of active orders |
Collection of ActiveOrderItem |
None. |
IsSuccessful |
If true, then method call was successful |
boolean |
None. |
ErrorMessage |
Contains an error message is method call failed |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ActiveOrders": [ { "ShipmentGUID": "sample string 1", "ShipmentNumber": 2, "OrderDate": "2024-12-28T09:26:45.4004057+00:00", "OrderStatus": 4, "OrderState": "sample string 5", "OrderStatusDisplay": "sample string 6", "TrackingNumber": "sample string 7", "OrderByName": "sample string 8", "Reference": "sample string 9", "Contents": "sample string 10", "PickupCompanyName": "sample string 11", "PickupAddress1": "sample string 12", "PickupAddress2": "sample string 13", "PickupAddress3": "sample string 14", "PickupCityName": "sample string 15", "PickupStateProvID": "sample string 16", "PickupPostalCode": "sample string 17", "PickupCountryID": "sample string 18", "DeliveryCompanyName": "sample string 19", "DeliveryAddress1": "sample string 20", "DeliveryAddress2": "sample string 21", "DeliveryAddress3": "sample string 22", "DeliveryCityName": "sample string 23", "DeliveryStateProvID": "sample string 24", "DeliveryPostalCode": "sample string 25", "DeliveryCountryID": "sample string 26", "HoldForPickup": true, "RecoverAirportID": "sample string 28", "WaybillNumber": "sample string 29", "RouteNumber": "sample string 30", "ArriveDateTime": "2024-12-28T09:26:45.4004057+00:00", "DisplayPickupAddress": "sample string 15 sample string 18", "DisplayDeliveryAddress": "sample string 23 sample string 26", "TrackingUrl": "/Secure/TrackOrder.aspx?ShipmentGUID=sample string 1&TrackingNumber=sample string 7", "UpdatedDeliveryDateTime": "2024-12-28T09:26:45.4004057+00:00", "UpdatedDeliveryDateTimeDisplay": "SAT DEC-28 09:26 AM", "PickupAddressFull": "sample string 11<br>sample string 12<br>sample string 13<br>sample string 14<br>sample string 15, sample string 16 sample string 17 sample string 18", "DeliveryAddressFull": "HOLD FOR PICKUP: sample string 28<br>MAWB#: sample string 29<br>FLIGHT: sample string 30<br>ARRIVE: SAT 28-DEC 09:26<br>sample string 23, sample string 24 sample string 25 sample string 26" }, { "ShipmentGUID": "sample string 1", "ShipmentNumber": 2, "OrderDate": "2024-12-28T09:26:45.4004057+00:00", "OrderStatus": 4, "OrderState": "sample string 5", "OrderStatusDisplay": "sample string 6", "TrackingNumber": "sample string 7", "OrderByName": "sample string 8", "Reference": "sample string 9", "Contents": "sample string 10", "PickupCompanyName": "sample string 11", "PickupAddress1": "sample string 12", "PickupAddress2": "sample string 13", "PickupAddress3": "sample string 14", "PickupCityName": "sample string 15", "PickupStateProvID": "sample string 16", "PickupPostalCode": "sample string 17", "PickupCountryID": "sample string 18", "DeliveryCompanyName": "sample string 19", "DeliveryAddress1": "sample string 20", "DeliveryAddress2": "sample string 21", "DeliveryAddress3": "sample string 22", "DeliveryCityName": "sample string 23", "DeliveryStateProvID": "sample string 24", "DeliveryPostalCode": "sample string 25", "DeliveryCountryID": "sample string 26", "HoldForPickup": true, "RecoverAirportID": "sample string 28", "WaybillNumber": "sample string 29", "RouteNumber": "sample string 30", "ArriveDateTime": "2024-12-28T09:26:45.4004057+00:00", "DisplayPickupAddress": "sample string 15 sample string 18", "DisplayDeliveryAddress": "sample string 23 sample string 26", "TrackingUrl": "/Secure/TrackOrder.aspx?ShipmentGUID=sample string 1&TrackingNumber=sample string 7", "UpdatedDeliveryDateTime": "2024-12-28T09:26:45.4004057+00:00", "UpdatedDeliveryDateTimeDisplay": "SAT DEC-28 09:26 AM", "PickupAddressFull": "sample string 11<br>sample string 12<br>sample string 13<br>sample string 14<br>sample string 15, sample string 16 sample string 17 sample string 18", "DeliveryAddressFull": "HOLD FOR PICKUP: sample string 28<br>MAWB#: sample string 29<br>FLIGHT: sample string 30<br>ARRIVE: SAT 28-DEC 09:26<br>sample string 23, sample string 24 sample string 25 sample string 26" } ], "IsSuccessful": true, "ErrorMessage": "sample string 2" }
application/xml, text/xml
Sample:
<ActiveOrdersResp xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <IsSuccessful>true</IsSuccessful> <ErrorMessage>sample string 2</ErrorMessage> <ActiveOrders> <ActiveOrderItem> <ShipmentGUID>sample string 1</ShipmentGUID> <ShipmentNumber>2</ShipmentNumber> <OrderDate>2024-12-28T09:26:45.4004057+00:00</OrderDate> <OrderStatus>4</OrderStatus> <OrderState>sample string 5</OrderState> <OrderStatusDisplay>sample string 6</OrderStatusDisplay> <TrackingNumber>sample string 7</TrackingNumber> <OrderByName>sample string 8</OrderByName> <Reference>sample string 9</Reference> <Contents>sample string 10</Contents> <PickupCompanyName>sample string 11</PickupCompanyName> <PickupAddress1>sample string 12</PickupAddress1> <PickupAddress2>sample string 13</PickupAddress2> <PickupAddress3>sample string 14</PickupAddress3> <PickupCityName>sample string 15</PickupCityName> <PickupStateProvID>sample string 16</PickupStateProvID> <PickupPostalCode>sample string 17</PickupPostalCode> <PickupCountryID>sample string 18</PickupCountryID> <DeliveryCompanyName>sample string 19</DeliveryCompanyName> <DeliveryAddress1>sample string 20</DeliveryAddress1> <DeliveryAddress2>sample string 21</DeliveryAddress2> <DeliveryAddress3>sample string 22</DeliveryAddress3> <DeliveryCityName>sample string 23</DeliveryCityName> <DeliveryStateProvID>sample string 24</DeliveryStateProvID> <DeliveryPostalCode>sample string 25</DeliveryPostalCode> <DeliveryCountryID>sample string 26</DeliveryCountryID> <HoldForPickup>true</HoldForPickup> <RecoverAirportID>sample string 28</RecoverAirportID> <WaybillNumber>sample string 29</WaybillNumber> <RouteNumber>sample string 30</RouteNumber> <ArriveDateTime>2024-12-28T09:26:45.4004057+00:00</ArriveDateTime> <UpdatedDeliveryDateTime>2024-12-28T09:26:45.4004057+00:00</UpdatedDeliveryDateTime> </ActiveOrderItem> <ActiveOrderItem> <ShipmentGUID>sample string 1</ShipmentGUID> <ShipmentNumber>2</ShipmentNumber> <OrderDate>2024-12-28T09:26:45.4004057+00:00</OrderDate> <OrderStatus>4</OrderStatus> <OrderState>sample string 5</OrderState> <OrderStatusDisplay>sample string 6</OrderStatusDisplay> <TrackingNumber>sample string 7</TrackingNumber> <OrderByName>sample string 8</OrderByName> <Reference>sample string 9</Reference> <Contents>sample string 10</Contents> <PickupCompanyName>sample string 11</PickupCompanyName> <PickupAddress1>sample string 12</PickupAddress1> <PickupAddress2>sample string 13</PickupAddress2> <PickupAddress3>sample string 14</PickupAddress3> <PickupCityName>sample string 15</PickupCityName> <PickupStateProvID>sample string 16</PickupStateProvID> <PickupPostalCode>sample string 17</PickupPostalCode> <PickupCountryID>sample string 18</PickupCountryID> <DeliveryCompanyName>sample string 19</DeliveryCompanyName> <DeliveryAddress1>sample string 20</DeliveryAddress1> <DeliveryAddress2>sample string 21</DeliveryAddress2> <DeliveryAddress3>sample string 22</DeliveryAddress3> <DeliveryCityName>sample string 23</DeliveryCityName> <DeliveryStateProvID>sample string 24</DeliveryStateProvID> <DeliveryPostalCode>sample string 25</DeliveryPostalCode> <DeliveryCountryID>sample string 26</DeliveryCountryID> <HoldForPickup>true</HoldForPickup> <RecoverAirportID>sample string 28</RecoverAirportID> <WaybillNumber>sample string 29</WaybillNumber> <RouteNumber>sample string 30</RouteNumber> <ArriveDateTime>2024-12-28T09:26:45.4004057+00:00</ArriveDateTime> <UpdatedDeliveryDateTime>2024-12-28T09:26:45.4004057+00:00</UpdatedDeliveryDateTime> </ActiveOrderItem> </ActiveOrders> </ActiveOrdersResp>