Click or drag to resize
ReporterProductTopSellers Method (Filter, Facets, String, Int32, Int32)
Fetches a ProductTopSellersReport. The report contains sales statistics for the best products and variants that matches the filter. The report is sorted according to the specified sort by order.

The report contains a list of sections, each containing the following values:

  • The product key.
  • The variant key or an empty String if it is a product.
  • The number of purchases during the time interval.
  • The number of abandonment during the time interval.
  • The total discount for the item during the time interval.
  • The total margin for the item during the time interval.
  • The total revenue for the item during the time interval.

Namespace:  Apptus.ESales.Connector
Assembly:  Apptus.Esales.ConnectorApi (in Apptus.Esales.ConnectorApi.dll) Version: 4.5.0
Syntax
C#
Copy
public ProductTopSellersReport ProductTopSellers(
	Filter filter,
	Facets facets,
	string sortBy,
	int windowFirst,
	int windowLast
)

Parameters

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 consider when the top list is created.
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]
windowFirst
Type: SystemInt32
The first position, inclusive, to be present in the report. The first position is 1.
windowLast
Type: SystemInt32
The last position, inclusive, to be present in the report.

Return Value

Type: ProductTopSellersReport
A ProductTopSellersReport
Remarks
Since 3.4.0
See Also