API Documentation
Back to top  

ProductListProviderInterface

Extends

Interface ProductListProviderInterface

category

System
package

Product
subpackage

Interfaces

Methods

Returns all product list items.

getAll() : \ProductListItemCollection

Response

\ProductListItemCollection

Returns a paged list of product items.

getAllPaged(\IntType|null $page = null, \IntType|null $limit = null) : \ProductListItemCollection

Arguments

$page

\IntType|null

(Optional) Offset of resource elements.

$limit

\IntType|null

(Optional) Maximum amount of elements per page.

Response

\ProductListItemCollection

Returns a product list item collection by the provided category ID.

getByCategoryId(\IdType $categoryId) : \ProductListItemCollection

Arguments

$categoryId

\IdType

Category ID.

Response

\ProductListItemCollection

Filters products records by a given ProductSearchCondition object and returns an array with results.

searchProducts(\ProductSearchCondition $condition, \Pager $pager) : \ProductListItemCollection

Arguments

$condition

\ProductSearchCondition

Conditions object for search.

$pager

\Pager

Pager object with page settings to split the results into several pages.

Response

\ProductListItemCollection