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

Class: SalesChannelLocationService

Service for managing the stock locations of sales channels

Hierarchy

• TransactionBaseService

  ↳ SalesChannelLocationService

Constructors

constructor

• new SalesChannelLocationService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/sales-channel-location.ts:26

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-location.ts:23

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/sales-channel-location.ts:19

---

salesChannelService_

• Protected Readonly salesChannelService_: SalesChannelService

Defined in

packages/medusa/src/services/sales-channel-location.ts:22

---

stockLocationService

• Protected Readonly stockLocationService: IStockLocationService

Defined in

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

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/sales-channel-location.ts:20

Methods

associateLocation

▸ associateLocation(salesChannelId, locationId): Promise<void>

Associates a sales channel with a stock location.

Parameters

Name	Type	Description
salesChannelId	string	The ID of the sales channel.
locationId	string	The ID of the stock location.

Returns

Promise<void>

A promise that resolves when the association has been created.

Defined in

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

---

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:48

---

listLocations

▸ listLocations(salesChannelId): Promise<string[]>

Lists the stock locations associated with a sales channel.

Parameters

Name	Type	Description
salesChannelId	string	The ID of the sales channel.

Returns

Promise<string[]>

A promise that resolves with an array of location IDs.

Defined in

packages/medusa/src/services/sales-channel-location.ts:87

---

removeLocation

▸ removeLocation(salesChannelId, locationId): Promise<void>

Removes an association between a sales channel and a stock location.

Parameters

Name	Type	Description
salesChannelId	string	The ID of the sales channel.
locationId	string	The ID of the stock location.

Returns

Promise<void>

A promise that resolves when the association has been removed.

Defined in

packages/medusa/src/services/sales-channel-location.ts:47

---

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:29

---

withTransaction

▸ withTransaction(transactionManager?): SalesChannelLocationService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

SalesChannelLocationService

Inherited from

TransactionBaseService.withTransaction

Defined in

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