SalesChannelLocationService
Service for managing the stock locations of sales channels
Hierarchy
TransactionBaseService↳
SalesChannelLocationService
Constructors
constructor
new SalesChannelLocationService(«destructured»)
Parameters
| Name |
|---|
«destructured» |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/sales-channel-location.ts:24
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_: IEventBusService
Defined in
medusa/src/services/sales-channel-location.ts:21
manager_
Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
salesChannelService_
Protected Readonly salesChannelService_: SalesChannelService
Defined in
medusa/src/services/sales-channel-location.ts:20
stockLocationService_
Protected Readonly stockLocationService_: IStockLocationService
Defined in
medusa/src/services/sales-channel-location.ts:22
transactionManager_
Protected transactionManager_: undefined | EntityManager
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Accessors
activeManager_
Protected get activeManager_(): EntityManager
Returns
EntityManager
-EntityManager:
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
Methods
associateLocation
associateLocation(salesChannelId, locationId): Promise<void>
Associates a sales channel with a stock location.
Parameters
| Name | Description |
|---|---|
salesChannelId | string |
locationId | string |
Returns
Promise<void>
-Promise: A promise that resolves when the association has been created.
Defined in
medusa/src/services/sales-channel-location.ts:72
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
listLocationIds
listLocationIds(salesChannelId): Promise<string[]>
Lists the stock locations associated with a sales channel.
Parameters
| Name | Description |
|---|---|
salesChannelId | string | string[] |
Returns
Promise<string[]>
-Promise: A promise that resolves with an array of location IDs.
-string[]:
-string: (optional)
Defined in
medusa/src/services/sales-channel-location.ts:103
listSalesChannelIds
listSalesChannelIds(locationId): Promise<string[]>
Lists the sales channels associated with a stock location.
Parameters
| Name |
|---|
locationId |
Returns
Promise<string[]>
-Promise: A promise that resolves with an array of sales channel IDs.
-string[]:
-string: (optional)
Defined in
medusa/src/services/sales-channel-location.ts:132
removeLocation
removeLocation(locationId, salesChannelId?): Promise<void>
Removes an association between a sales channel and a stock location.
Parameters
| Name | Description |
|---|---|
locationId | string |
salesChannelId? | string |
Returns
Promise<void>
-Promise: A promise that resolves when the association has been removed.
Defined in
medusa/src/services/sales-channel-location.ts:43
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
withTransaction
withTransaction(transactionManager?): SalesChannelLocationService
Parameters
| Name |
|---|
transactionManager? |
Returns
-SalesChannelLocationService:
Inherited from
TransactionBaseService.withTransaction