listSalesChannels - Sales Channel Module Reference

This documentation provides a reference to the listSalesChannels method. This belongs to the Sales Channel 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 sales channels based on optional filters and configuration.

Example#

To retrieve a list of sales channels using their IDs:

Code
1const salesChannels = await salesChannelModuleService.listSalesChannels({2  id: ["sc_123", "sc_321"],3})

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

Code
1const salesChannels = await salesChannelModuleService.listSalesChannels(2  {3    id: ["sc_123", "sc_321"],4  },5  {6    take: 20,7    skip: 2,8  }9)

Parameters#

filtersFilterableSalesChannelPropsOptional

The filters to apply on the retrieved sales channels.

configFindConfig<SalesChannelDTO>Optional

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.

sharedContextContextOptional

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

Returns#

PromisePromise<SalesChannelDTO[]>

The list of sales channels.