GET Courier/Dashboard?key={key}

Request Information

URI Parameters

Name	Description	Type	Additional information
key		string	Required

Body Parameters

None.

Response Information

Resource Description

CourierDashboard

Name	Type	Additional information
CourierDashboardData	CourierDasboardData	None.
ActivePackages	Collection of CourierPackageData	None.
CompletedPackages	Collection of CourierPackageData	None.
BreakAndShiftStatus	CourierActiveStatusDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "CourierDashboardData": {
    "ID": 1,
    "CourierCompanyID": 2,
    "Name": "sample string 3",
    "Phone": "sample string 4",
    "Online": true,
    "ShowQr": true
  },
  "ActivePackages": [
    {
      "ID": 1,
      "StatusID": 2,
      "IntegrationType": 3,
      "SortIndex": 4,
      "OrderID2": "sample string 5",
      "Restaurant": "sample string 6",
      "RestaurantAddress": "sample string 7",
      "Destination": "sample string 8",
      "Status": "sample string 9",
      "Date": "2026-03-18T12:05:31.0270288+03:00"
    },
    {
      "ID": 1,
      "StatusID": 2,
      "IntegrationType": 3,
      "SortIndex": 4,
      "OrderID2": "sample string 5",
      "Restaurant": "sample string 6",
      "RestaurantAddress": "sample string 7",
      "Destination": "sample string 8",
      "Status": "sample string 9",
      "Date": "2026-03-18T12:05:31.0270288+03:00"
    }
  ],
  "CompletedPackages": [
    {
      "ID": 1,
      "StatusID": 2,
      "IntegrationType": 3,
      "SortIndex": 4,
      "OrderID2": "sample string 5",
      "Restaurant": "sample string 6",
      "RestaurantAddress": "sample string 7",
      "Destination": "sample string 8",
      "Status": "sample string 9",
      "Date": "2026-03-18T12:05:31.0270288+03:00"
    },
    {
      "ID": 1,
      "StatusID": 2,
      "IntegrationType": 3,
      "SortIndex": 4,
      "OrderID2": "sample string 5",
      "Restaurant": "sample string 6",
      "RestaurantAddress": "sample string 7",
      "Destination": "sample string 8",
      "Status": "sample string 9",
      "Date": "2026-03-18T12:05:31.0270288+03:00"
    }
  ],
  "BreakAndShiftStatus": {
    "BreakTimeStatus": {
      "InBreak": true,
      "StatusData": {
        "RecordId": 1,
        "Duration": 2,
        "StartDate": "2026-03-18T12:05:31.0270288+03:00",
        "EndDate": "2026-03-18T12:05:31.0270288+03:00"
      }
    },
    "ShiftStatus": {
      "InShift": true,
      "ActiveShiftItems": [
        {
          "Id": 1,
          "ItemId": 2,
          "WeekId": 3,
          "DayId": 4,
          "StartTime": "sample string 5",
          "EndTime": "sample string 6",
          "BreakTime": 7,
          "AutoOnline": true,
          "AutoOffline": true,
          "Date": "2026-03-18T12:05:31.0270288+03:00",
          "InShift": true
        },
        {
          "Id": 1,
          "ItemId": 2,
          "WeekId": 3,
          "DayId": 4,
          "StartTime": "sample string 5",
          "EndTime": "sample string 6",
          "BreakTime": 7,
          "AutoOnline": true,
          "AutoOffline": true,
          "Date": "2026-03-18T12:05:31.0270288+03:00",
          "InShift": true
        }
      ]
    }
  }
}

application/xml, text/xml

Sample:

<CourierDashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RestAPI.Models.DTOs">
  <ActivePackages>
    <CourierPackageData>
      <Date>2026-03-18T12:05:31.0270288+03:00</Date>
      <Destination>sample string 8</Destination>
      <ID>1</ID>
      <IntegrationType>3</IntegrationType>
      <OrderID2>sample string 5</OrderID2>
      <Restaurant>sample string 6</Restaurant>
      <RestaurantAddress>sample string 7</RestaurantAddress>
      <SortIndex>4</SortIndex>
      <Status>sample string 9</Status>
      <StatusID>2</StatusID>
    </CourierPackageData>
    <CourierPackageData>
      <Date>2026-03-18T12:05:31.0270288+03:00</Date>
      <Destination>sample string 8</Destination>
      <ID>1</ID>
      <IntegrationType>3</IntegrationType>
      <OrderID2>sample string 5</OrderID2>
      <Restaurant>sample string 6</Restaurant>
      <RestaurantAddress>sample string 7</RestaurantAddress>
      <SortIndex>4</SortIndex>
      <Status>sample string 9</Status>
      <StatusID>2</StatusID>
    </CourierPackageData>
  </ActivePackages>
  <BreakAndShiftStatus>
    <BreakTimeStatus>
      <InBreak>true</InBreak>
      <StatusData>
        <Duration>2</Duration>
        <EndDate>2026-03-18T12:05:31.0270288+03:00</EndDate>
        <RecordId>1</RecordId>
        <StartDate>2026-03-18T12:05:31.0270288+03:00</StartDate>
      </StatusData>
    </BreakTimeStatus>
    <ShiftStatus>
      <ActiveShiftItems>
        <ActiveShiftItemsDTO>
          <AutoOffline>true</AutoOffline>
          <AutoOnline>true</AutoOnline>
          <BreakTime>7</BreakTime>
          <Date>2026-03-18T12:05:31.0270288+03:00</Date>
          <DayId>4</DayId>
          <EndTime>sample string 6</EndTime>
          <Id>1</Id>
          <InShift>true</InShift>
          <ItemId>2</ItemId>
          <StartTime>sample string 5</StartTime>
          <WeekId>3</WeekId>
        </ActiveShiftItemsDTO>
        <ActiveShiftItemsDTO>
          <AutoOffline>true</AutoOffline>
          <AutoOnline>true</AutoOnline>
          <BreakTime>7</BreakTime>
          <Date>2026-03-18T12:05:31.0270288+03:00</Date>
          <DayId>4</DayId>
          <EndTime>sample string 6</EndTime>
          <Id>1</Id>
          <InShift>true</InShift>
          <ItemId>2</ItemId>
          <StartTime>sample string 5</StartTime>
          <WeekId>3</WeekId>
        </ActiveShiftItemsDTO>
      </ActiveShiftItems>
      <InShift>true</InShift>
    </ShiftStatus>
  </BreakAndShiftStatus>
  <CompletedPackages>
    <CourierPackageData>
      <Date>2026-03-18T12:05:31.0270288+03:00</Date>
      <Destination>sample string 8</Destination>
      <ID>1</ID>
      <IntegrationType>3</IntegrationType>
      <OrderID2>sample string 5</OrderID2>
      <Restaurant>sample string 6</Restaurant>
      <RestaurantAddress>sample string 7</RestaurantAddress>
      <SortIndex>4</SortIndex>
      <Status>sample string 9</Status>
      <StatusID>2</StatusID>
    </CourierPackageData>
    <CourierPackageData>
      <Date>2026-03-18T12:05:31.0270288+03:00</Date>
      <Destination>sample string 8</Destination>
      <ID>1</ID>
      <IntegrationType>3</IntegrationType>
      <OrderID2>sample string 5</OrderID2>
      <Restaurant>sample string 6</Restaurant>
      <RestaurantAddress>sample string 7</RestaurantAddress>
      <SortIndex>4</SortIndex>
      <Status>sample string 9</Status>
      <StatusID>2</StatusID>
    </CourierPackageData>
  </CompletedPackages>
  <CourierDashboardData>
    <CourierCompanyID>2</CourierCompanyID>
    <ID>1</ID>
    <Name>sample string 3</Name>
    <Online>true</Online>
    <Phone>sample string 4</Phone>
    <ShowQr>true</ShowQr>
  </CourierDashboardData>
</CourierDashboard>