listLineItems - Cart Module Reference

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

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

Example

To retrieve a list of line items using their IDs:

const lineItems = await cartModuleService.listLineItems({
  id: ["cali_123", "cali_321"],
})

To specify relations that should be retrieved within the line items:

const lineItems = await cartModuleService.listLineItems(
  {
    id: ["cali_123", "cali_321"],
  },
  {
    relations: ["cart"],
  }
)

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 lineItems = await cartModuleService.listLineItems(
  {
    id: ["cali_123", "cali_321"],
  },
  {
    relations: ["cart"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableLineItemPropsRequired

The filters to apply on the retrieved line items.

configFindConfig<CartLineItemDTO>

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

sharedContextContext

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

Returns

PromisePromise<CartLineItemDTO[]>Required

The list of line items.