listAndCountCarts - Cart Module Reference
This documentation provides a reference to the listAndCountCarts
method. This belongs to the Cart Module.
Note: You should only use this methods when implementing complex customizations. For common cases, check out
available workflows instead .
This method retrieves a paginated list of carts along with the total count of available carts satisfying the provided filters.
Example#
To retrieve a list of carts using their IDs:
1 const [ carts , count ] = await cartModuleService . listAndCountCarts ( { 2 id : [ "cart_123" , "cart_321" ] , 3 } )
To specify relations that should be retrieved within the carts:
Note: You can only retrieve data models defined in the same module. To retrieve linked data models
from other modules, use
Query instead.
1 const [ carts , count ] = await cartModuleService . listAndCountCarts ( 2 { 3 id : [ "cart_123" , "cart_321" ] , 4 } , 5 { 6 relations : [ "shipping_address" ] , 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:
1 const [ carts , count ] = await cartModuleService . listAndCountCarts ( 2 { 3 id : [ "cart_123" , "cart_321" ] , 4 } , 5 { 6 relations : [ "shipping_address" ] , 7 take : 20 , 8 skip : 2 , 9 } 10 )
Parameters#
The filters to apply on the retrieved carts.
The configurations determining how the cart is retrieved. Its properties, such as select
or relations
, accept the
attributes or relations associated with a cart.
A context used to share resources, such as transaction manager, between the application and the module.
Returns#
Promise
Promise<[CartDTO [], number]> The list of carts along with their total count.