POST
api/v1/location-wise-sales-summary-report
Request Information
Body Parameters
ProductsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ClientId | integer |
None. |
|
| SellerId | integer |
None. |
|
| PageNumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| Search | string |
None. |
|
| OrderBy | string |
None. |
|
| OrderDir | string |
None. |
|
| FromDate | date |
None. |
|
| ToDate | date |
None. |
Request Formats
application/json, text/json
{
"ClientId": 1,
"SellerId": 2,
"PageNumber": 3,
"PageSize": 4,
"Search": "sample string 5",
"OrderBy": "sample string 6",
"OrderDir": "sample string 7",
"FromDate": "2026-02-05T05:27:25.8932197+00:00",
"ToDate": "2026-02-05T05:27:25.8932197+00:00"
}
text/html
{"ClientId":1,"SellerId":2,"PageNumber":3,"PageSize":4,"Search":"sample string 5","OrderBy":"sample string 6","OrderDir":"sample string 7","FromDate":"2026-02-05T05:27:25.8932197+00:00","ToDate":"2026-02-05T05:27:25.8932197+00:00"}
application/xml, text/xml
<ProductsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Order"> <ClientId>1</ClientId> <FromDate>2026-02-05T05:27:25.8932197+00:00</FromDate> <OrderBy>sample string 6</OrderBy> <OrderDir>sample string 7</OrderDir> <PageNumber>3</PageNumber> <PageSize>4</PageSize> <Search>sample string 5</Search> <SellerId>2</SellerId> <ToDate>2026-02-05T05:27:25.8932197+00:00</ToDate> </ProductsRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Description:
Return type: Collection of LocationWiseSalesSummaryReport
Response Formats
application/json, text/json
[
{
"State": "sample string 1",
"City": "sample string 2",
"TotalOrders": 3,
"ActiveOrders": 4,
"CancelledOrders": 5,
"ReturnedOrders": 6,
"DeliveredOrders": 7,
"TotalRevenue": 8.0,
"NetOrderRevenue": 9.0,
"AverageOrderValue": 10.0,
"TopSellingCategories": "sample string 11",
"AverageDeliveryTime": 12.1,
"ReturnRate": 13.1,
"CustomerCount": 14,
"TotalRows": 15
},
{
"State": "sample string 1",
"City": "sample string 2",
"TotalOrders": 3,
"ActiveOrders": 4,
"CancelledOrders": 5,
"ReturnedOrders": 6,
"DeliveredOrders": 7,
"TotalRevenue": 8.0,
"NetOrderRevenue": 9.0,
"AverageOrderValue": 10.0,
"TopSellingCategories": "sample string 11",
"AverageDeliveryTime": 12.1,
"ReturnRate": 13.1,
"CustomerCount": 14,
"TotalRows": 15
}
]
text/html
[{"State":"sample string 1","City":"sample string 2","TotalOrders":3,"ActiveOrders":4,"CancelledOrders":5,"ReturnedOrders":6,"DeliveredOrders":7,"TotalRevenue":8.0,"NetOrderRevenue":9.0,"AverageOrderValue":10.0,"TopSellingCategories":"sample string 11","AverageDeliveryTime":12.1,"ReturnRate":13.1,"CustomerCount":14,"TotalRows":15},{"State":"sample string 1","City":"sample string 2","TotalOrders":3,"ActiveOrders":4,"CancelledOrders":5,"ReturnedOrders":6,"DeliveredOrders":7,"TotalRevenue":8.0,"NetOrderRevenue":9.0,"AverageOrderValue":10.0,"TopSellingCategories":"sample string 11","AverageDeliveryTime":12.1,"ReturnRate":13.1,"CustomerCount":14,"TotalRows":15}]
application/xml, text/xml
<ArrayOfLocationWiseSalesSummaryReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Order">
<LocationWiseSalesSummaryReport>
<ActiveOrders>4</ActiveOrders>
<AverageDeliveryTime>12.1</AverageDeliveryTime>
<AverageOrderValue>10</AverageOrderValue>
<CancelledOrders>5</CancelledOrders>
<City>sample string 2</City>
<CustomerCount>14</CustomerCount>
<DeliveredOrders>7</DeliveredOrders>
<NetOrderRevenue>9</NetOrderRevenue>
<ReturnRate>13.1</ReturnRate>
<ReturnedOrders>6</ReturnedOrders>
<State>sample string 1</State>
<TopSellingCategories>sample string 11</TopSellingCategories>
<TotalOrders>3</TotalOrders>
<TotalRevenue>8</TotalRevenue>
<TotalRows>15</TotalRows>
</LocationWiseSalesSummaryReport>
<LocationWiseSalesSummaryReport>
<ActiveOrders>4</ActiveOrders>
<AverageDeliveryTime>12.1</AverageDeliveryTime>
<AverageOrderValue>10</AverageOrderValue>
<CancelledOrders>5</CancelledOrders>
<City>sample string 2</City>
<CustomerCount>14</CustomerCount>
<DeliveredOrders>7</DeliveredOrders>
<NetOrderRevenue>9</NetOrderRevenue>
<ReturnRate>13.1</ReturnRate>
<ReturnedOrders>6</ReturnedOrders>
<State>sample string 1</State>
<TopSellingCategories>sample string 11</TopSellingCategories>
<TotalOrders>3</TotalOrders>
<TotalRevenue>8</TotalRevenue>
<TotalRows>15</TotalRows>
</LocationWiseSalesSummaryReport>
</ArrayOfLocationWiseSalesSummaryReport>
