listProducts - Product Module Reference
This documentation provides a reference to the listProducts
method. This belongs to the Product Module.
Note: You should only use this methods when implementing complex customizations. For common cases, check out
available workflows instead.
This method is used to retrieve a paginated list of products based on optional filters and configuration.
Example#
To retrieve a list of products using their IDs:
1const products = await productModuleService.listProducts({2 id: ["prod_123", "prod_321"],3})
To specify relations that should be retrieved within the products:
Note: You can only retrieve data models defined in the same module. To retrieve linked data models
from other modules, use
Query instead.
1const products = await productModuleService.listProducts(2 {3 id: ["prod_123", "prod_321"],4 },5 {6 relations: ["categories"],7 }8)
By default, only the first 15
records are retrieved. You can control pagination by specifying the skip
and take
properties of the config
parameter:
1const products = await productModuleService.listProducts(2 {3 id: ["prod_123", "prod_321"],4 },5 {6 relations: ["categories"],7 take: 20,8 skip: 2,9 }10)
Parameters#
The filters to apply on the retrieved products.
The configurations determining how the products are retrieved. Its properties, such as select
or relations
, accept the
attributes or relations associated with a product.
A context used to share resources, such as transaction manager, between the application and the module.
Returns#