list - Cart Module Reference

This documentation provides a reference to the list method. This belongs to the Cart Module.

This method retrieves a paginated list of carts based on optional filters and configuration.

Example

To retrieve a list of carts using their IDs:

const carts = await cartModuleService.list({
  id: ["cart_123", "cart_321"],
})

To specify relations that should be retrieved within the carts:

const carts = await cartModuleService.list(
  {
    id: ["cart_123", "cart_321"],
  },
  {
    relations: ["shipping_address"],
  }
)

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const carts = await cartModuleService.list(
  {
    id: ["cart_123", "cart_321"],
  },
  {
    relations: ["shipping_address"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableCartProps

The filters to apply on the retrieved carts.

configFindConfig<CartDTO>

The configurations determining how the cart is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a cart.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<CartDTO[]>Required

The list of carts.