Download the PHP package oxcom/magento2-top-products without Composer
On this page you can find all versions of the php package oxcom/magento2-top-products. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download oxcom/magento2-top-products
More information about oxcom/magento2-top-products
Files in oxcom/magento2-top-products
Package magento2-top-products
Short Description This is a module that extends Magento2 API to get list of TOP products.
License LGPL-3.0
Homepage https://github.com/OxCom/magento2-top-products
Informations about the package magento2-top-products
Magento2 Top Products API
This is a module that extends Magento2 API to get list of TOP products by next filters:
- TOP selling products
- TOP Free products
- TOP Rated products
Top selling and free products are fetching from Magento2 reports.
Top rated products are fetching from Rates module and results are based on aggregated data.
Install
API requests
- Get list of top products by type.
Where can be:
- selling - TOP selling products
- free - TOP Free products
- rated - TOP Rated products
Search criteria params
pageSize - Page size
currentPage - Current page
ratingCode - filter by rating type. This options is related ony for type. Possible values can be found in table.
period - filter by period. This options is related only for or type. Possible values are:
- yearly - annual report (default)
- monthly - monthly report
- daily - daily report
filter_groups - As product search criteria this filter will allow you to process products collection with more requirements.
Search criteria examples:
Filter top selling products by:
- period: daily
- price > 10
- visibility = 4
- pageSize = 10
- currentPage = 2
Filter top rated products by:
- ratingCode: Rating
- status = 2
- visibility = 4
- pageSize = 10
- currentPage = 2
Dependencies
This module is using exists functionality of next modules:
- magento/module-catalog
- magento/module-review
- magento/module-sales
Bugs and Issues
Please, if You found a bug or something, that is not working properly, contact me and tell what's wrong. It's nice to have an example how to reproduce a bug, or any idea how to fix it in Your request. I'll take care about it ASAP.
All versions of magento2-top-products with dependencies
magento/module-config Version 100.0.*|100.1.*|101.0.*|101.1.*|101.2.*
magento/module-store Version 100.0.*|100.1.*|100.2.*|101.0.*|101.1.*
magento/module-backend Version 100.0.*|100.1.*|100.2.*|101.0.*|102.0.*|103.0.*
magento/module-directory Version 100.0.*|100.1.*|100.2.*|100.3.*|100.4.*
magento/framework Version 100.0.*|100.1.*|101.0.*|102.0.*|103.0.*