retrieveSalesChannel - Sales Channel Module Reference

This documentation provides a reference to the retrieveSalesChannel 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 sales channel by its ID.

Example#

Code
1const salesChannel =2  await salesChannelModuleService.retrieveSalesChannel("sc_123")

Parameters#

idstring

The ID of the sales channel.

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 retrieved sales channel.