GET api/dashboard/overview

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
code	integer	None.
message	string	None.
status	string	None.
data	DashboardOverviewData	None.

Response Formats

application/json, text/json

Sample:

{
  "code": 1,
  "message": "sample string 2",
  "status": "sample string 3",
  "data": {
    "TodaysOrders": {
      "TotalOrders": 1,
      "Pending": 2,
      "Confirmed": 3,
      "Packed": 4,
      "OutForDelivery": 5,
      "Delivered": 6,
      "Cancelled": 7
    },
    "TodaysComplaints": {
      "TotalComplaints": 1,
      "Open": 2,
      "InProgress": 3,
      "Resolved": 4
    },
    "ReturnRefundRequests": {
      "TotalRequests": 1,
      "Pending": 2,
      "Approved": 3,
      "Rejected": 4
    }
  }
}

application/xml, text/xml

Sample:

<DashboardOverviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Models">
  <code>1</code>
  <data>
    <ReturnRefundRequests>
      <Approved>3</Approved>
      <Pending>2</Pending>
      <Rejected>4</Rejected>
      <TotalRequests>1</TotalRequests>
    </ReturnRefundRequests>
    <TodaysComplaints>
      <InProgress>3</InProgress>
      <Open>2</Open>
      <Resolved>4</Resolved>
      <TotalComplaints>1</TotalComplaints>
    </TodaysComplaints>
    <TodaysOrders>
      <Cancelled>7</Cancelled>
      <Confirmed>3</Confirmed>
      <Delivered>6</Delivered>
      <OutForDelivery>5</OutForDelivery>
      <Packed>4</Packed>
      <Pending>2</Pending>
      <TotalOrders>1</TotalOrders>
    </TodaysOrders>
  </data>
  <message>sample string 2</message>
  <status>sample string 3</status>
</DashboardOverviewResponse>