GET api/Dashboard/{DashboardGUID}?DestAirport={DestAirport}&ServiceCodeList={ServiceCodeList}

Get the raw data for active shipments that can be displayed on a Dashboard

Request Information

URI Parameters

NameDescriptionTypeAdditional information
DashboardGUID

Unique global identifer used to identify active shipments on the linked accounts

 string

Required
DestAirport

Optional destination airport filter

 string

Default value is

ServiceCodeList

Optional service code filter

 string

Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of DashboardItem
NameDescriptionTypeAdditional information
OrderStatus

Numeric order status

 integer

None.
OrderState

Order state or disposition of the order (AC=active, CN=cancelled, DL=deleted)

 string

None.
UpdatedDeliveryDateTime

Raw estimated delivery date/time

 date

None.
DspUpdatedDeliveryDateTime

Formatted estimated delivery date/time

 string

None.
ShipmentNumber

Unique numeric shipment number

 integer

None.
TrackingNumber

Airbill or tracking number (optional, use ShipmentNumber)

 string

None.
DspOrderNumber

Format order number (TrackingNumber or ShipmentNumber)

 string

None.
PickupCompanyName

Company name at pickup

 string

None.
PickupCityName

City name at pickup

 string

None.
PickupStateProvID

State/prov at pickup

 string

None.
PickupCountryID

Country identifier at pickup

 string

None.
DspPickupLocation

Formatted pickup address

 string

None.
DeliveryCompanyName

Company name at delivery

 string

None.
DeliveryCityName

City name at delivery

 string

None.
DeliveryStateProvID

State/Prov at pickup

 string

None.
DeliveryCountryID

Country identifier at delivery

 string

None.
DspDeliveryLocation

Formatted delivery address

 string

None.
PickupAirportID

Origin airport code

 string

None.
DeliveryAirportID

Destination airport code

 string

None.
FlightInfo

Flight information (air shipment only)

 string

None.
ArriveDateTime

Arrival time of flight (if applicable)

 date

None.
DspArriveDateTime

Formatted arrival time of flight (if applicable)

 string

None.
OrderStatusDisplay

Formatted order status

 string

None.
Reference

Main reference value for this shipment

 string

None.
Pieces

Number of pieces in the shipment

 integer

None.
Weight

Total weight of the shipment

 decimal number

None.
WeightUOM

Weight unit of measure (LB,KG)

 string

None.
DispatchPickupDateTime

Date/Time courier was dispatched to pickup (local time)

 date

None.
DispatchDeliveryDateTime

Date/Time courier was dispatched to delivery (local time)

 date

None.
DepartDateTime

Date/Time first flight departed (local time)

 date

None.
CustomerReferences

Customer reference values for this shipment

 Collection of CustomerReference

None.
OtherReferences

Other reference values for this shipment

 Collection of Reference

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "ArriveDateTime": "2025-04-03T13:24:23.891-07:00",
    "CustomerReferences": [
      {
        "Code": "sample string 2",
        "DashboardVisible": true,
        "ID": 1,
        "Name": "sample string 3",
        "Value": "sample string 4"
      },
      {
        "Code": "sample string 2",
        "DashboardVisible": true,
        "ID": 1,
        "Name": "sample string 3",
        "Value": "sample string 4"
      }
    ],
    "DeliveryAirportID": "sample string 18",
    "DeliveryCityName": "sample string 13",
    "DeliveryCompanyName": "sample string 12",
    "DeliveryCountryID": "sample string 15",
    "DeliveryStateProvID": "sample string 14",
    "DepartDateTime": "2025-04-03T13:24:23.892-07:00",
    "DispatchDeliveryDateTime": "2025-04-03T13:24:23.892-07:00",
    "DispatchPickupDateTime": "2025-04-03T13:24:23.892-07:00",
    "DspArriveDateTime": "sample string 20",
    "DspDeliveryLocation": "sample string 16",
    "DspOrderNumber": "sample string 6",
    "DspPickupLocation": "sample string 11",
    "DspUpdatedDeliveryDateTime": "sample string 3",
    "FlightInfo": "sample string 19",
    "OrderState": "sample string 2",
    "OrderStatus": 1,
    "OrderStatusDisplay": "sample string 21",
    "OtherReferences": [
      {
        "Code": "sample string 2",
        "ID": 1,
        "Name": "sample string 3",
        "Value": "sample string 4"
      },
      {
        "Code": "sample string 2",
        "ID": 1,
        "Name": "sample string 3",
        "Value": "sample string 4"
      }
    ],
    "PickupAirportID": "sample string 17",
    "PickupCityName": "sample string 8",
    "PickupCompanyName": "sample string 7",
    "PickupCountryID": "sample string 10",
    "PickupStateProvID": "sample string 9",
    "Pieces": 23,
    "Reference": "sample string 22",
    "ShipmentNumber": 4,
    "TrackingNumber": "sample string 5",
    "UpdatedDeliveryDateTime": "2025-04-03T13:24:23.891-07:00",
    "Weight": 1,
    "WeightUOM": "sample string 24"
  },
  {
    "ArriveDateTime": "2025-04-03T13:24:23.891-07:00",
    "CustomerReferences": [
      {
        "Code": "sample string 2",
        "DashboardVisible": true,
        "ID": 1,
        "Name": "sample string 3",
        "Value": "sample string 4"
      },
      {
        "Code": "sample string 2",
        "DashboardVisible": true,
        "ID": 1,
        "Name": "sample string 3",
        "Value": "sample string 4"
      }
    ],
    "DeliveryAirportID": "sample string 18",
    "DeliveryCityName": "sample string 13",
    "DeliveryCompanyName": "sample string 12",
    "DeliveryCountryID": "sample string 15",
    "DeliveryStateProvID": "sample string 14",
    "DepartDateTime": "2025-04-03T13:24:23.892-07:00",
    "DispatchDeliveryDateTime": "2025-04-03T13:24:23.892-07:00",
    "DispatchPickupDateTime": "2025-04-03T13:24:23.892-07:00",
    "DspArriveDateTime": "sample string 20",
    "DspDeliveryLocation": "sample string 16",
    "DspOrderNumber": "sample string 6",
    "DspPickupLocation": "sample string 11",
    "DspUpdatedDeliveryDateTime": "sample string 3",
    "FlightInfo": "sample string 19",
    "OrderState": "sample string 2",
    "OrderStatus": 1,
    "OrderStatusDisplay": "sample string 21",
    "OtherReferences": [
      {
        "Code": "sample string 2",
        "ID": 1,
        "Name": "sample string 3",
        "Value": "sample string 4"
      },
      {
        "Code": "sample string 2",
        "ID": 1,
        "Name": "sample string 3",
        "Value": "sample string 4"
      }
    ],
    "PickupAirportID": "sample string 17",
    "PickupCityName": "sample string 8",
    "PickupCompanyName": "sample string 7",
    "PickupCountryID": "sample string 10",
    "PickupStateProvID": "sample string 9",
    "Pieces": 23,
    "Reference": "sample string 22",
    "ShipmentNumber": 4,
    "TrackingNumber": "sample string 5",
    "UpdatedDeliveryDateTime": "2025-04-03T13:24:23.891-07:00",
    "Weight": 1,
    "WeightUOM": "sample string 24"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfDashboardItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <DashboardItem>
    <ArriveDateTime>2025-04-03T13:24:23.8916323-07:00</ArriveDateTime>
    <CustomerReferences>
      <CustomerReference>
        <Code>sample string 2</Code>
        <DashboardVisible>true</DashboardVisible>
        <ID>1</ID>
        <Name>sample string 3</Name>
        <Value>sample string 4</Value>
      </CustomerReference>
      <CustomerReference>
        <Code>sample string 2</Code>
        <DashboardVisible>true</DashboardVisible>
        <ID>1</ID>
        <Name>sample string 3</Name>
        <Value>sample string 4</Value>
      </CustomerReference>
    </CustomerReferences>
    <DeliveryAirportID>sample string 18</DeliveryAirportID>
    <DeliveryCityName>sample string 13</DeliveryCityName>
    <DeliveryCompanyName>sample string 12</DeliveryCompanyName>
    <DeliveryCountryID>sample string 15</DeliveryCountryID>
    <DeliveryStateProvID>sample string 14</DeliveryStateProvID>
    <DepartDateTime>2025-04-03T13:24:23.8926332-07:00</DepartDateTime>
    <DispatchDeliveryDateTime>2025-04-03T13:24:23.8926332-07:00</DispatchDeliveryDateTime>
    <DispatchPickupDateTime>2025-04-03T13:24:23.8926332-07:00</DispatchPickupDateTime>
    <DspArriveDateTime>sample string 20</DspArriveDateTime>
    <DspDeliveryLocation>sample string 16</DspDeliveryLocation>
    <DspOrderNumber>sample string 6</DspOrderNumber>
    <DspPickupLocation>sample string 11</DspPickupLocation>
    <DspUpdatedDeliveryDateTime>sample string 3</DspUpdatedDeliveryDateTime>
    <FlightInfo>sample string 19</FlightInfo>
    <OrderState>sample string 2</OrderState>
    <OrderStatus>1</OrderStatus>
    <OrderStatusDisplay>sample string 21</OrderStatusDisplay>
    <OtherReferences>
      <Reference>
        <Code>sample string 2</Code>
        <ID>1</ID>
        <Name>sample string 3</Name>
        <Value>sample string 4</Value>
      </Reference>
      <Reference>
        <Code>sample string 2</Code>
        <ID>1</ID>
        <Name>sample string 3</Name>
        <Value>sample string 4</Value>
      </Reference>
    </OtherReferences>
    <PickupAirportID>sample string 17</PickupAirportID>
    <PickupCityName>sample string 8</PickupCityName>
    <PickupCompanyName>sample string 7</PickupCompanyName>
    <PickupCountryID>sample string 10</PickupCountryID>
    <PickupStateProvID>sample string 9</PickupStateProvID>
    <Pieces>23</Pieces>
    <Reference>sample string 22</Reference>
    <ShipmentNumber>4</ShipmentNumber>
    <TrackingNumber>sample string 5</TrackingNumber>
    <UpdatedDeliveryDateTime>2025-04-03T13:24:23.8916323-07:00</UpdatedDeliveryDateTime>
    <Weight>1</Weight>
    <WeightUOM>sample string 24</WeightUOM>
  </DashboardItem>
  <DashboardItem>
    <ArriveDateTime>2025-04-03T13:24:23.8916323-07:00</ArriveDateTime>
    <CustomerReferences>
      <CustomerReference>
        <Code>sample string 2</Code>
        <DashboardVisible>true</DashboardVisible>
        <ID>1</ID>
        <Name>sample string 3</Name>
        <Value>sample string 4</Value>
      </CustomerReference>
      <CustomerReference>
        <Code>sample string 2</Code>
        <DashboardVisible>true</DashboardVisible>
        <ID>1</ID>
        <Name>sample string 3</Name>
        <Value>sample string 4</Value>
      </CustomerReference>
    </CustomerReferences>
    <DeliveryAirportID>sample string 18</DeliveryAirportID>
    <DeliveryCityName>sample string 13</DeliveryCityName>
    <DeliveryCompanyName>sample string 12</DeliveryCompanyName>
    <DeliveryCountryID>sample string 15</DeliveryCountryID>
    <DeliveryStateProvID>sample string 14</DeliveryStateProvID>
    <DepartDateTime>2025-04-03T13:24:23.8926332-07:00</DepartDateTime>
    <DispatchDeliveryDateTime>2025-04-03T13:24:23.8926332-07:00</DispatchDeliveryDateTime>
    <DispatchPickupDateTime>2025-04-03T13:24:23.8926332-07:00</DispatchPickupDateTime>
    <DspArriveDateTime>sample string 20</DspArriveDateTime>
    <DspDeliveryLocation>sample string 16</DspDeliveryLocation>
    <DspOrderNumber>sample string 6</DspOrderNumber>
    <DspPickupLocation>sample string 11</DspPickupLocation>
    <DspUpdatedDeliveryDateTime>sample string 3</DspUpdatedDeliveryDateTime>
    <FlightInfo>sample string 19</FlightInfo>
    <OrderState>sample string 2</OrderState>
    <OrderStatus>1</OrderStatus>
    <OrderStatusDisplay>sample string 21</OrderStatusDisplay>
    <OtherReferences>
      <Reference>
        <Code>sample string 2</Code>
        <ID>1</ID>
        <Name>sample string 3</Name>
        <Value>sample string 4</Value>
      </Reference>
      <Reference>
        <Code>sample string 2</Code>
        <ID>1</ID>
        <Name>sample string 3</Name>
        <Value>sample string 4</Value>
      </Reference>
    </OtherReferences>
    <PickupAirportID>sample string 17</PickupAirportID>
    <PickupCityName>sample string 8</PickupCityName>
    <PickupCompanyName>sample string 7</PickupCompanyName>
    <PickupCountryID>sample string 10</PickupCountryID>
    <PickupStateProvID>sample string 9</PickupStateProvID>
    <Pieces>23</Pieces>
    <Reference>sample string 22</Reference>
    <ShipmentNumber>4</ShipmentNumber>
    <TrackingNumber>sample string 5</TrackingNumber>
    <UpdatedDeliveryDateTime>2025-04-03T13:24:23.8916323-07:00</UpdatedDeliveryDateTime>
    <Weight>1</Weight>
    <WeightUOM>sample string 24</WeightUOM>
  </DashboardItem>
</ArrayOfDashboardItem>