medusa-store/docs/content/references/services/classes/SalesChannelService.md

Class: SalesChannelService

Hierarchy

• TransactionBaseService

  ↳ SalesChannelService

Constructors

constructor

• new SalesChannelService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/sales-channel.ts:37

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:10

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:9

---

eventBusService_

• Protected Readonly eventBusService_: EventBusService

Defined in

packages/medusa/src/services/sales-channel.ts:34

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/sales-channel.ts:30

---

salesChannelRepository_

• Protected Readonly salesChannelRepository_: typeof SalesChannelRepository

Defined in

packages/medusa/src/services/sales-channel.ts:33

---

storeService_

• Protected Readonly storeService_: StoreService

Defined in

packages/medusa/src/services/sales-channel.ts:35

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/sales-channel.ts:31

---

Events

▪ Static Events: Object

Type declaration

Name	Type
CREATED	string
DELETED	string
UPDATED	string

Defined in

packages/medusa/src/services/sales-channel.ts:24

Methods

addProducts

▸ addProducts(salesChannelId, productIds): Promise<SalesChannel>

Add a batch of product to a sales channel

Parameters

Name	Type	Description
salesChannelId	string	The id of the sales channel on which to add the products
productIds	string[]	The products ids to attach to the sales channel

Returns

Promise<SalesChannel>

the sales channel on which the products have been added

Defined in

packages/medusa/src/services/sales-channel.ts:310

---

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Type parameters

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>	the transactional work to be done
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>	the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>	Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:50

---

create

▸ create(data): Promise<SalesChannel>

Creates a SalesChannel

This feature is under development and may change in the future. To use this feature please enable the corresponding feature flag in your medusa backend project.

Parameters

Name	Type
data	CreateSalesChannelInput

Returns

Promise<SalesChannel>

the created channel

Defined in

packages/medusa/src/services/sales-channel.ts:167

---

createDefault

▸ createDefault(): Promise<SalesChannel>

Creates a default sales channel, if this does not already exist.

Returns

Promise<SalesChannel>

the sales channel

Defined in

packages/medusa/src/services/sales-channel.ts:257

---

delete

▸ delete(salesChannelId): Promise<void>

Deletes a sales channel from This feature is under development and may change in the future. To use this feature please enable the corresponding feature flag in your medusa backend project.

Parameters

Name	Type	Description
salesChannelId	string	the id of the sales channel to delete

Returns

Promise<void>

Defined in

packages/medusa/src/services/sales-channel.ts:218

---

listAndCount

▸ listAndCount(selector, config?): Promise<[SalesChannel[], number]>

Lists sales channels based on the provided parameters and includes the count of sales channels that match the query.

Parameters

Name	Type
selector	QuerySelector<SalesChannel>
config	FindConfig<SalesChannel>

Returns

Promise<[SalesChannel[], number]>

an array containing the sales channels as the first element and the total count of sales channels that matches the query as the second element.

Defined in

packages/medusa/src/services/sales-channel.ts:132

---

removeProducts

▸ removeProducts(salesChannelId, productIds): Promise<SalesChannel>

Remove a batch of product from a sales channel

Parameters

Name	Type	Description
salesChannelId	string	The id of the sales channel on which to remove the products
productIds	string[]	The products ids to remove from the sales channel

Returns

Promise<SalesChannel>

the sales channel on which the products have been removed

Defined in

packages/medusa/src/services/sales-channel.ts:289

---

retrieve

▸ retrieve(salesChannelId, config?): Promise<SalesChannel>

Retrieve a SalesChannel by id

Parameters

Name	Type	Description
salesChannelId	string	id of the channel to retrieve
config	FindConfig<SalesChannel>	SC config This feature is under development and may change in the future. To use this feature please enable the corresponding feature flag in your medusa backend project.

Returns

Promise<SalesChannel>

a sales channel

Defined in

packages/medusa/src/services/sales-channel.ts:104

---

retrieveByName

▸ retrieveByName(name, config?): Promise<unknown>

Find a sales channel by name.

Parameters

Name	Type	Description
name	string	of the sales channel
config	FindConfig<SalesChannel>	find config

Returns

Promise<unknown>

a sales channel with matching name

Defined in

packages/medusa/src/services/sales-channel.ts:118

---

retrieve_

▸ Protected retrieve_(selector, config?): Promise<SalesChannel>

A generic retrieve used to find a sales channel by different attributes.

Parameters

Name	Type	Description
selector	Selector<SalesChannel>	SC selector
config	FindConfig<SalesChannel>	find config

Returns

Promise<SalesChannel>

a single SC matching the query or throws

Defined in

packages/medusa/src/services/sales-channel.ts:64

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:31

---

update

▸ update(salesChannelId, data): Promise<SalesChannel>

Parameters

Name	Type
salesChannelId	string
data	Partial<CreateSalesChannelInput>

Returns

Promise<SalesChannel>

Defined in

packages/medusa/src/services/sales-channel.ts:184

---

withTransaction

▸ withTransaction(transactionManager?): SalesChannelService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

SalesChannelService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:13