list - Sales Channel Module Reference

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

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

Example

To retrieve a list of sales channels using their IDs:

const salesChannels = await salesChannelModuleService.list({
  id: ["sc_123", "sc_321"],
})

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 salesChannels = await salesChannelModuleService.list(
  {
    id: ["sc_123", "sc_321"],
  },
  {
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableSalesChannelProps

The filters to apply on the retrieved sales channels.

configFindConfig<SalesChannelDTO>

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

sharedContextContext

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

Returns

PromisePromise<SalesChannelDTO[]>Required

The list of sales channels.