POST SalesByCategoryReport/GenerateReportByCategory

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.SalesReport.SalesByCategoryReport.ReportViewModel
NameDescriptionTypeAdditional 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": "2025-04-03T22:34:49.6279323-04:00",
  "End": "2025-04-03T22:34:49.6279323-04:00",
  "StartDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":34,\"seconds\":49,\"miliseconds\":627}",
  "EndDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":34,\"seconds\":49,\"miliseconds\":627}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of IConnect.Domain.Reports.SalesReport.SalesByCategoryReport.CatReportItem
NameDescriptionTypeAdditional information
ItemID

integer

None.
CategoryId

integer

None.
ParentCategoryId

integer

None.
Name

string

None.
ParentCategoryName

string

None.
FullName

string

None.
SKU

string

None.
Quantity

decimal number

None.
Subtotal

decimal number

None.
Discount

decimal number

None.
Tax

decimal number

None.
Total

decimal number

None.
SubTotalAfterDiscount

decimal number

None.
Margin

decimal number

None.
MarginPercent

decimal number

None.
SalesPercentage

decimal number

None.
TotalCostPercentage

decimal number

None.
IsLeaf

boolean

None.
Order

integer

None.
CategoryCode

string

None.
CategoryGuid

globally unique identifier

None.
ParentCategoryGuid

globally unique identifier

None.
TotalCost

decimal number

None.
FullTotal

decimal number

None.
FullMargin

decimal number

None.
Level

integer

None.
ChildrenList

Collection of IConnect.Domain.Reports.SalesReport.SalesByCategoryReport.CatReportItem

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.