POST SalesByCategoryReport/GenerateReport
Request Information
URI Parameters
None.
Body Parameters
IConnect.Domain.Reports.SalesReport.SalesByCategoryReport.ReportViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ByCategory | boolean |
None. |
|
| SelectedCategory | integer |
None. |
|
| SelectedProductType | integer |
None. |
|
| SelectedSortBy | integer |
None. |
|
| ShowByCategory | boolean |
None. |
|
| SelectedShowBy | integer |
None. |
|
| ExcludeGiftCards | boolean |
None. |
|
| ShowBy | IConnect.Domain.Reports.SalesReport.SalesByCategoryReport.ShowBy |
None. |
|
| DefaultShowBy | IConnect.Domain.Reports.SalesReport.SalesByCategoryReport.ShowBy |
None. |
|
| ShowByList | Collection of IConnect.Core.JsonSimpleViewModel |
None. |
|
| MenuShowByList | Collection of IConnect.Core.JsonSimpleViewModel |
None. |
|
| SortBy | IConnect.Domain.Reports.SalesReport.SalesByCategoryReport.SortBy |
None. |
|
| DefaultSortBy | IConnect.Domain.Reports.SalesReport.SalesByCategoryReport.SortBy |
None. |
|
| SortByList | Collection of IConnect.Core.JsonSimpleViewModel |
None. |
|
| ProductType | IConnect.Domain.Reports.ProductType |
None. |
|
| DefaultProductType | IConnect.Domain.Reports.ProductType |
None. |
|
| ProductTypeList | Collection of IConnect.Core.JsonSimpleViewModel |
None. |
|
| LocationNameForExport | string |
None. |
|
| SelectedCompanies | Collection of integer |
None. |
|
| OrderSource | IConnect.Domain.Orders.DisplayOrderSource |
None. |
|
| Start | date |
None. |
|
| End | date |
None. |
|
| StartDateObjectString | string |
None. |
|
| EndDateObjectString | string |
None. |
|
| SkipTimeZoneConvertion | boolean |
None. |
|
| ForceImmediateExport | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"ByCategory": true,
"SelectedCategory": 2,
"SelectedProductType": 3,
"SelectedSortBy": 4,
"ShowByCategory": true,
"SelectedShowBy": 6,
"ExcludeGiftCards": true,
"ShowBy": 0,
"DefaultShowBy": 0,
"ShowByList": [
{
"id": {},
"name": "sample string 2"
},
{
"id": {},
"name": "sample string 2"
}
],
"MenuShowByList": [
{
"id": {},
"name": "sample string 2"
},
{
"id": {},
"name": "sample string 2"
}
],
"SortBy": 0,
"DefaultSortBy": 0,
"SortByList": [
{
"id": {},
"name": "sample string 2"
},
{
"id": {},
"name": "sample string 2"
}
],
"ProductType": 0,
"DefaultProductType": 0,
"ProductTypeList": [
{
"id": {},
"name": "sample string 2"
},
{
"id": {},
"name": "sample string 2"
}
],
"LocationNameForExport": "sample string 8",
"SelectedCompanies": [
1,
2
],
"OrderSource": 1,
"Start": "2024-10-18T04:40:10.9040306-04:00",
"End": "2024-10-18T04:40:10.9040306-04:00",
"StartDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":40,\"seconds\":10,\"miliseconds\":904}",
"EndDateObjectString": "{\"year\":2024,\"month\":10,\"date\":18,\"hours\":4,\"minutes\":40,\"seconds\":10,\"miliseconds\":904}",
"SkipTimeZoneConvertion": true,
"ForceImmediateExport": true
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ObjectNone.
Response Formats
application/json, text/json
Sample:
{}
application/xml, text/xml
Sample:
<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />