POST api/v1/category-sales-distribution-summary

Request Information

Body Parameters

ProductReportRequest
NameDescriptionTypeAdditional information
ClientId

integer

None.

SellerId

integer

None.

PageNo

integer

None.

PageSize

integer

None.

SearchText

string

None.

SortField

string

None.

SortDirection

string

None.

StartDate

date

None.

EndDate

date

None.

Request Formats
{
  "ClientId": 1,
  "SellerId": 2,
  "PageNo": 3,
  "PageSize": 4,
  "SearchText": "sample string 5",
  "SortField": "sample string 6",
  "SortDirection": "sample string 7",
  "StartDate": "2026-02-05T05:27:33.7688756+00:00",
  "EndDate": "2026-02-05T05:27:33.7688756+00:00"
}
{"ClientId":1,"SellerId":2,"PageNo":3,"PageSize":4,"SearchText":"sample string 5","SortField":"sample string 6","SortDirection":"sample string 7","StartDate":"2026-02-05T05:27:33.7688756+00:00","EndDate":"2026-02-05T05:27:33.7688756+00:00"}
<ProductReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Sku">
  <ClientId>1</ClientId>
  <EndDate>2026-02-05T05:27:33.7688756+00:00</EndDate>
  <PageNo>3</PageNo>
  <PageSize>4</PageSize>
  <SearchText>sample string 5</SearchText>
  <SellerId>2</SellerId>
  <SortDirection>sample string 7</SortDirection>
  <SortField>sample string 6</SortField>
  <StartDate>2026-02-05T05:27:33.7688756+00:00</StartDate>
</ProductReportRequest>

Sample not available.

Response Information

Description:

Return type: CategorySalesDistributionReport

Response Formats
{
  "CategorySalesDistributionList": [
    {
      "CategoryName": "sample string 1",
      "TotalOrders": 2,
      "DeliveredOrders": 3,
      "ReturnedOrders": 4,
      "TotalSales": 5.0,
      "PercOfTotalSales": 6.0,
      "AvgOrderValue": 7.0,
      "ReturnRate": 8.0,
      "NoOfProducts": 9
    },
    {
      "CategoryName": "sample string 1",
      "TotalOrders": 2,
      "DeliveredOrders": 3,
      "ReturnedOrders": 4,
      "TotalSales": 5.0,
      "PercOfTotalSales": 6.0,
      "AvgOrderValue": 7.0,
      "ReturnRate": 8.0,
      "NoOfProducts": 9
    }
  ],
  "TotalCount": 1
}
{"CategorySalesDistributionList":[{"CategoryName":"sample string 1","TotalOrders":2,"DeliveredOrders":3,"ReturnedOrders":4,"TotalSales":5.0,"PercOfTotalSales":6.0,"AvgOrderValue":7.0,"ReturnRate":8.0,"NoOfProducts":9},{"CategoryName":"sample string 1","TotalOrders":2,"DeliveredOrders":3,"ReturnedOrders":4,"TotalSales":5.0,"PercOfTotalSales":6.0,"AvgOrderValue":7.0,"ReturnRate":8.0,"NoOfProducts":9}],"TotalCount":1}
<CategorySalesDistributionReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Sku">
  <CategorySalesDistributionList>
    <CategorySalesDistributionList>
      <AvgOrderValue>7</AvgOrderValue>
      <CategoryName>sample string 1</CategoryName>
      <DeliveredOrders>3</DeliveredOrders>
      <NoOfProducts>9</NoOfProducts>
      <PercOfTotalSales>6</PercOfTotalSales>
      <ReturnRate>8</ReturnRate>
      <ReturnedOrders>4</ReturnedOrders>
      <TotalOrders>2</TotalOrders>
      <TotalSales>5</TotalSales>
    </CategorySalesDistributionList>
    <CategorySalesDistributionList>
      <AvgOrderValue>7</AvgOrderValue>
      <CategoryName>sample string 1</CategoryName>
      <DeliveredOrders>3</DeliveredOrders>
      <NoOfProducts>9</NoOfProducts>
      <PercOfTotalSales>6</PercOfTotalSales>
      <ReturnRate>8</ReturnRate>
      <ReturnedOrders>4</ReturnedOrders>
      <TotalOrders>2</TotalOrders>
      <TotalSales>5</TotalSales>
    </CategorySalesDistributionList>
  </CategorySalesDistributionList>
  <TotalCount>1</TotalCount>
</CategorySalesDistributionReport>