SalesChannelInventoryService
Hierarchy
TransactionBaseService↳
SalesChannelInventoryService
Constructors
constructor
new SalesChannelInventoryService(«destructured»)
Parameters
| Name |
|---|
«destructured» |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/sales-channel-inventory.ts:18
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-inventory.ts:15
inventoryService_
Protected Readonly inventoryService_: IInventoryService
Defined in
medusa/src/services/sales-channel-inventory.ts:16
manager_
Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
salesChannelLocationService_
Protected Readonly salesChannelLocationService_: SalesChannelLocationService
Defined in
medusa/src/services/sales-channel-inventory.ts:14
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
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
retrieveAvailableItemQuantity
retrieveAvailableItemQuantity(salesChannelId, inventoryItemId): Promise<number>
Retrieves the available quantity of an item across all sales channel locations
Parameters
| Name | Description |
|---|---|
salesChannelId | string |
inventoryItemId | string |
Returns
Promise<number>
-Promise: available quantity of item across all sales channel locations
-number: (optional)
Defined in
medusa/src/services/sales-channel-inventory.ts:37
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?): SalesChannelInventoryService
Parameters
| Name |
|---|
transactionManager? |
Returns
-SalesChannelInventoryService:
Inherited from
TransactionBaseService.withTransaction