retrieve - Sales Channel Module Reference

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

This method retrieves a sales channel by its ID.

Example

const salesChannel =
  await salesChannelModuleService.retrieve("sc_123")

Parameters

idstringRequired

The ID of the sales channel.

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