POST
api/v1/top-selling-product-summary
Request Information
Body Parameters
ProductReportRequest| Name | Description | Type | Additional 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
application/json, text/json
{
"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:22.88794+00:00",
"EndDate": "2026-02-05T05:27:22.88794+00:00"
}
text/html
{"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:22.88794+00:00","EndDate":"2026-02-05T05:27:22.88794+00:00"}
application/xml, text/xml
<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:22.88794+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:22.88794+00:00</StartDate> </ProductReportRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Description:
Return type: TopSellingProductsReport
Response Formats
application/json, text/json
{
"TopSellingProductsList": [
{
"Rank": 1,
"ProductName": "sample string 2",
"WishlistItems": 3,
"SavedCartItems": 4,
"UnitsSold": 5,
"TotalRevenue": 6.0,
"AvgSellingPrice": 7.0,
"Category": "sample string 8"
},
{
"Rank": 1,
"ProductName": "sample string 2",
"WishlistItems": 3,
"SavedCartItems": 4,
"UnitsSold": 5,
"TotalRevenue": 6.0,
"AvgSellingPrice": 7.0,
"Category": "sample string 8"
}
],
"TotalCount": 1
}
text/html
{"TopSellingProductsList":[{"Rank":1,"ProductName":"sample string 2","WishlistItems":3,"SavedCartItems":4,"UnitsSold":5,"TotalRevenue":6.0,"AvgSellingPrice":7.0,"Category":"sample string 8"},{"Rank":1,"ProductName":"sample string 2","WishlistItems":3,"SavedCartItems":4,"UnitsSold":5,"TotalRevenue":6.0,"AvgSellingPrice":7.0,"Category":"sample string 8"}],"TotalCount":1}
application/xml, text/xml
<TopSellingProductsReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Sku">
<TopSellingProductsList>
<TopSellingProductsList>
<AvgSellingPrice>7</AvgSellingPrice>
<Category>sample string 8</Category>
<ProductName>sample string 2</ProductName>
<Rank>1</Rank>
<SavedCartItems>4</SavedCartItems>
<TotalRevenue>6</TotalRevenue>
<UnitsSold>5</UnitsSold>
<WishlistItems>3</WishlistItems>
</TopSellingProductsList>
<TopSellingProductsList>
<AvgSellingPrice>7</AvgSellingPrice>
<Category>sample string 8</Category>
<ProductName>sample string 2</ProductName>
<Rank>1</Rank>
<SavedCartItems>4</SavedCartItems>
<TotalRevenue>6</TotalRevenue>
<UnitsSold>5</UnitsSold>
<WishlistItems>3</WishlistItems>
</TopSellingProductsList>
</TopSellingProductsList>
<TotalCount>1</TotalCount>
</TopSellingProductsReport>
