SalesChannelService

Hierarchy

• TransactionBaseService

  ↳ SalesChannelService

Constructors

constructor

new SalesChannelService(«destructured»)

Parameters

Name
«destructured»

Overrides

TransactionBaseService.constructor

Defined in

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

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14

---

__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

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

---

__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

---

eventBusService_

Protected Readonly eventBusService_: EventBusService

Defined in

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

---

manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

---

salesChannelRepository_

Protected Readonly salesChannelRepository_: Repository<SalesChannel> & { addProducts: Method addProducts ; getFreeTextSearchResultsAndCount: Method getFreeTextSearchResultsAndCount ; listProductIdsBySalesChannelIds: Method listProductIdsBySalesChannelIds ; removeProducts: Method removeProducts }

Defined in

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

---

storeService_

Protected Readonly storeService_: StoreService

Defined in

medusa/src/services/sales-channel.ts:32

---

transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

---

Events

Static Events: Object

Type declaration

Name	Type
CREATED	string
DELETED	string
UPDATED	string

Defined in

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

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

-EntityManager:

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

addProducts

addProducts(salesChannelId, productIds): Promise<SalesChannel>

Add a batch of product to a sales channel

Parameters

Name	Description
salesChannelId	string
productIds	string[]

Returns

Promise<SalesChannel>

-Promise: the sales channel on which the products have been added -SalesChannel:

Defined in

medusa/src/services/sales-channel.ts:348

---

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.

Name
TResult
TError

Parameters

Name	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

-Promise: the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

---

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
data

Returns

Promise<SalesChannel>

-Promise: the created channel -SalesChannel:

Defined in

medusa/src/services/sales-channel.ts:168

---

createDefault

createDefault(): Promise<SalesChannel>

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

Returns

Promise<SalesChannel>

-Promise: the sales channel -SalesChannel:

Defined in

medusa/src/services/sales-channel.ts:258

---

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	Description
salesChannelId	string

Returns

Promise<void>

-Promise:

Defined in

medusa/src/services/sales-channel.ts:219

---

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
selector
config

Returns

Promise<[SalesChannel[], number]>

-Promise: 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. -SalesChannel[]: -number: (optional)

Defined in

medusa/src/services/sales-channel.ts:134

---

listProductIdsBySalesChannelIds

listProductIdsBySalesChannelIds(salesChannelIds): Promise<{ [salesChannelId: string]: string[]; }>

List all product ids that belongs to the sales channels ids

Parameters

Name
salesChannelIds

Returns

Promise<{ [salesChannelId: string]: string[]; }>

-Promise: -object: (optional)

Defined in

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

---

removeProducts

removeProducts(salesChannelId, productIds): Promise<SalesChannel>

Remove a batch of product from a sales channel

Parameters

Name	Description
salesChannelId	string
productIds	string[]

Returns

Promise<SalesChannel>

-Promise: the sales channel on which the products have been removed -SalesChannel:

Defined in

medusa/src/services/sales-channel.ts:327

---

retrieve

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

Retrieve a SalesChannel by id

Parameters

Name	Description
salesChannelId	string
config	FindConfig<SalesChannel>

Returns

Promise<SalesChannel>

-Promise: a sales channel -SalesChannel:

Defined in

medusa/src/services/sales-channel.ts:92

---

retrieveByName

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

Find a sales channel by name.

Parameters

Name	Description
name	string
config	FindConfig<SalesChannel>

Returns

Promise<unknown>

-Promise: a sales channel with matching name -unknown: (optional)

Defined in

medusa/src/services/sales-channel.ts:113

---

retrieveDefault

retrieveDefault(): Promise<SalesChannel>

Retrieves the default sales channel.

Returns

Promise<SalesChannel>

-Promise: the sales channel -SalesChannel:

Defined in

medusa/src/services/sales-channel.ts:288

---

retrieve_

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

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

Parameters

Name	Description
selector	Selector<SalesChannel>
config	FindConfig<SalesChannel>

Returns

Promise<SalesChannel>

-Promise: a single SC matching the query or throws -SalesChannel:

Defined in

medusa/src/services/sales-channel.ts:54

---

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name
err

Returns

boolean

-boolean: (optional)

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

---

update

update(salesChannelId, data): Promise<SalesChannel>

Parameters

Name
salesChannelId
data

Returns

Promise<SalesChannel>

-Promise: -SalesChannel:

Defined in

medusa/src/services/sales-channel.ts:185

---

withTransaction

withTransaction(transactionManager?): SalesChannelService

Parameters

Name
transactionManager?

Returns

SalesChannelService

-SalesChannelService:

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20