POST api/Report/GetTopProductBySaleForDashboard

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ProductID	integer	None.
ProductVariantID	integer	None.
UserID	integer	None.
SubCategoryID	integer	None.
CashRegisterID	integer	None.
OutletID	integer	None.
CustomerID	integer	None.
ClientAddressID	integer	None.
BrandID	integer	None.
ColorID	integer	None.
SeriesID	integer	None.
BrandTypeID	integer	None.
SizeID	integer	None.
ConnecterTypeID	integer	None.
PackagingID	integer	None.
PowerID	integer	None.
PrintID	integer	None.
CapacityID	integer	None.
QualityLabelID	integer	None.
ToDate	date	None.
FromDate	date	None.
PageSize	integer	None.
PageNo	integer	None.
IsGetAll	boolean	None.
Status	integer	None.
ByCustomer	boolean	None.
DayOfWeekID	integer	None.
AreaID	integer	None.
ID	integer	None.
ByUser	boolean	None.
IsForGraph	boolean	None.
IsAppRequest	boolean	None.
Customer	string	None.
Product	string	None.
IsReceived	boolean	None.
IsIncomingOrder	boolean	None.
PermissionLevel	integer	None.
Type	integer	None.
IsAproved	boolean	None.
IsPurchased	boolean	None.
EmailAddress	string	None.
ContactNo	string	None.
ColumnName	string	None.
IsOrderBySearch	boolean	None.
IsColumnSearch	boolean	None.
IsOrderByAccending	boolean	None.
IsImageAttached	boolean	None.
ResellerID	integer	None.
IsReseller	boolean	None.
RequestedUserID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ProductID": 1,
  "ProductVariantID": 1,
  "UserID": 1,
  "SubCategoryID": 1,
  "CashRegisterID": 1,
  "OutletID": 1,
  "CustomerID": 1,
  "ClientAddressID": 1,
  "BrandID": 1,
  "ColorID": 1,
  "SeriesID": 1,
  "BrandTypeID": 1,
  "SizeID": 1,
  "ConnecterTypeID": 1,
  "PackagingID": 1,
  "PowerID": 1,
  "PrintID": 1,
  "CapacityID": 1,
  "QualityLabelID": 1,
  "ToDate": "2025-01-22T20:50:28.2185074-06:00",
  "FromDate": "2025-01-22T20:50:28.2185074-06:00",
  "PageSize": 3,
  "PageNo": 4,
  "IsGetAll": true,
  "Status": 1,
  "ByCustomer": true,
  "DayOfWeekID": 7,
  "AreaID": 1,
  "ID": 1,
  "ByUser": true,
  "IsForGraph": true,
  "IsAppRequest": true,
  "Customer": "sample string 11",
  "Product": "sample string 12",
  "IsReceived": true,
  "IsIncomingOrder": true,
  "PermissionLevel": 1,
  "Type": 1,
  "IsAproved": true,
  "IsPurchased": true,
  "EmailAddress": "sample string 15",
  "ContactNo": "sample string 16",
  "ColumnName": "sample string 17",
  "IsOrderBySearch": true,
  "IsColumnSearch": true,
  "IsOrderByAccending": true,
  "IsImageAttached": true,
  "ResellerID": 1,
  "IsReseller": true,
  "RequestedUserID": 1
}

application/xml, text/xml

Sample:

<FilterRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
  <RequestedUserID xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.Request">1</RequestedUserID>
  <AreaID>1</AreaID>
  <BrandID>1</BrandID>
  <BrandTypeID>1</BrandTypeID>
  <ByCustomer>true</ByCustomer>
  <ByUser>true</ByUser>
  <CapacityID>1</CapacityID>
  <CashRegisterID>1</CashRegisterID>
  <ClientAddressID>1</ClientAddressID>
  <ColorID>1</ColorID>
  <ColumnName>sample string 17</ColumnName>
  <ConnecterTypeID>1</ConnecterTypeID>
  <ContactNo>sample string 16</ContactNo>
  <Customer>sample string 11</Customer>
  <CustomerID>1</CustomerID>
  <DayOfWeekID>7</DayOfWeekID>
  <EmailAddress>sample string 15</EmailAddress>
  <FromDate>2025-01-22T20:50:28.2185074-06:00</FromDate>
  <ID>1</ID>
  <IsAppRequest>true</IsAppRequest>
  <IsAproved>true</IsAproved>
  <IsColumnSearch>true</IsColumnSearch>
  <IsForGraph>true</IsForGraph>
  <IsGetAll>true</IsGetAll>
  <IsImageAttached>true</IsImageAttached>
  <IsIncomingOrder>true</IsIncomingOrder>
  <IsOrderByAccending>true</IsOrderByAccending>
  <IsOrderBySearch>true</IsOrderBySearch>
  <IsPurchased>true</IsPurchased>
  <IsReceived>true</IsReceived>
  <IsReseller>true</IsReseller>
  <OutletID>1</OutletID>
  <PackagingID>1</PackagingID>
  <PageNo>4</PageNo>
  <PageSize>3</PageSize>
  <PermissionLevel>1</PermissionLevel>
  <PowerID>1</PowerID>
  <PrintID>1</PrintID>
  <Product>sample string 12</Product>
  <ProductID>1</ProductID>
  <ProductVariantID>1</ProductVariantID>
  <QualityLabelID>1</QualityLabelID>
  <ResellerID>1</ResellerID>
  <SeriesID>1</SeriesID>
  <SizeID>1</SizeID>
  <Status>1</Status>
  <SubCategoryID>1</SubCategoryID>
  <ToDate>2025-01-22T20:50:28.2185074-06:00</ToDate>
  <Type>1</Type>
  <UserID>1</UserID>
</FilterRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetTopProductResponse

Name	Type	Additional information
TopProducts	Collection of TopProductModel	None.
ResponseCode	integer	None.
ResponseText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "TopProducts": [
    {
      "SKU": "sample string 1",
      "SalePrice": 1.0,
      "PurchasePrice": 1.0,
      "Product": "sample string 2",
      "Image": "sample string 3",
      "Quantity": 4
    },
    {
      "SKU": "sample string 1",
      "SalePrice": 1.0,
      "PurchasePrice": 1.0,
      "Product": "sample string 2",
      "Image": "sample string 3",
      "Quantity": 4
    }
  ],
  "ResponseCode": 1,
  "ResponseText": "sample string 2"
}

application/xml, text/xml

Sample:

<GetTopProductResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
  <ResponseCode>1</ResponseCode>
  <ResponseText>sample string 2</ResponseText>
  <TopProducts>
    <TopProductModel>
      <Image>sample string 3</Image>
      <Product>sample string 2</Product>
      <PurchasePrice>1</PurchasePrice>
      <Quantity>4</Quantity>
      <SKU>sample string 1</SKU>
      <SalePrice>1</SalePrice>
    </TopProductModel>
    <TopProductModel>
      <Image>sample string 3</Image>
      <Product>sample string 2</Product>
      <PurchasePrice>1</PurchasePrice>
      <Quantity>4</Quantity>
      <SKU>sample string 1</SKU>
      <SalePrice>1</SalePrice>
    </TopProductModel>
  </TopProducts>
</GetTopProductResponse>