ReporterProductSalesByAttribute Method (String, Filter, Facets, String) |
Fetches a
ProductSalesByAttributeReport.
The report is aggregated by facet values for the given attribute or a summary if the attribute is
null.
The report contains a section for each facet value. Each section contains:
- Name of the facet value.
- The total number of purchased products and variants that has this facet value and matches the filter.
- The total number of abandoned products and variants that has this facet value and matches the filter.
- The total discount for the products and variants that has this facet value and matches the filter.
- The total margin for the products and variants that has this facet value and matches the filter.
- The total revenue for the products and variants that has this facet value and matches the filter.
Namespace:
Apptus.ESales.Connector
Assembly:
Apptus.Esales.ConnectorApi (in Apptus.Esales.ConnectorApi.dll) Version: 4.5.0
Syntax public ProductSalesByAttributeReport ProductSalesByAttribute(
string attribute,
Filter filter,
Facets facets,
string sortBy
)
Parameters
- attribute
- Type: SystemString
The filter attribute to find facet values for. - filter
- Type: Apptus.ESales.ConnectorFilter
A filter defining the product set to report on. - facets
- Type: Apptus.ESales.ConnectorFacets
Together with filter, the set of products and variant to create the report for. - sortBy
- Type: SystemString
Sort order, one of the following:
- purchased_units [asc|desc]
- abandoned_units [asc|desc]
- discount [asc|desc]
- margin [asc|desc]
- revenue [asc|desc]
- attribute [asc|desc]
Return Value
Type:
ProductSalesByAttributeReportA
ProductSalesByAttributeReportRemarks Since 3.4.0
See Also