POST
api/v1/sub-category-performance-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:39.1979358+00:00",
"EndDate": "2026-02-05T05:27:39.1979358+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:39.1979358+00:00","EndDate":"2026-02-05T05:27:39.1979358+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:39.1979358+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:39.1979358+00:00</StartDate> </ProductReportRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Description:
Return type: SubCategoryPerformanceReport
Response Formats
application/json, text/json
{
"SubCategoryPerformanceList": [
{
"SubCategory": "sample string 1",
"ParentCategory": "sample string 2",
"TotalProducts": 3,
"TotalOrders": 4,
"DeliveredOrders": 5,
"ReturnedOrders": 6,
"TotalSales": 7.0,
"PurchasedByCustomers": 8,
"Status": "sample string 9"
},
{
"SubCategory": "sample string 1",
"ParentCategory": "sample string 2",
"TotalProducts": 3,
"TotalOrders": 4,
"DeliveredOrders": 5,
"ReturnedOrders": 6,
"TotalSales": 7.0,
"PurchasedByCustomers": 8,
"Status": "sample string 9"
}
],
"TotalCount": 1
}
text/html
{"SubCategoryPerformanceList":[{"SubCategory":"sample string 1","ParentCategory":"sample string 2","TotalProducts":3,"TotalOrders":4,"DeliveredOrders":5,"ReturnedOrders":6,"TotalSales":7.0,"PurchasedByCustomers":8,"Status":"sample string 9"},{"SubCategory":"sample string 1","ParentCategory":"sample string 2","TotalProducts":3,"TotalOrders":4,"DeliveredOrders":5,"ReturnedOrders":6,"TotalSales":7.0,"PurchasedByCustomers":8,"Status":"sample string 9"}],"TotalCount":1}
application/xml, text/xml
<SubCategoryPerformanceReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Sku">
<SubCategoryPerformanceList>
<SubCategoryPerformanceList>
<DeliveredOrders>5</DeliveredOrders>
<ParentCategory>sample string 2</ParentCategory>
<PurchasedByCustomers>8</PurchasedByCustomers>
<ReturnedOrders>6</ReturnedOrders>
<Status>sample string 9</Status>
<SubCategory>sample string 1</SubCategory>
<TotalOrders>4</TotalOrders>
<TotalProducts>3</TotalProducts>
<TotalSales>7</TotalSales>
</SubCategoryPerformanceList>
<SubCategoryPerformanceList>
<DeliveredOrders>5</DeliveredOrders>
<ParentCategory>sample string 2</ParentCategory>
<PurchasedByCustomers>8</PurchasedByCustomers>
<ReturnedOrders>6</ReturnedOrders>
<Status>sample string 9</Status>
<SubCategory>sample string 1</SubCategory>
<TotalOrders>4</TotalOrders>
<TotalProducts>3</TotalProducts>
<TotalSales>7</TotalSales>
</SubCategoryPerformanceList>
</SubCategoryPerformanceList>
<TotalCount>1</TotalCount>
</SubCategoryPerformanceReport>
