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

Class: SalesChannelInventoryService

Hierarchy

• TransactionBaseService

  ↳ SalesChannelInventoryService

Constructors

constructor

• new SalesChannelInventoryService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

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

utils/dist/common/transaction-base-service.d.ts:5

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

utils/dist/common/transaction-base-service.d.ts:4

---

__moduleDeclaration__

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

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

utils/dist/common/transaction-base-service.d.ts:6

---

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

utils/dist/common/transaction-base-service.d.ts:7

---

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

utils/dist/common/transaction-base-service.d.ts:8

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

utils/dist/common/transaction-base-service.d.ts:9

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.

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

utils/dist/common/transaction-base-service.d.ts:24

---

retrieveAvailableItemQuantity

▸ retrieveAvailableItemQuantity(salesChannelId, inventoryItemId): Promise<number>

Retrieves the available quantity of an item across all sales channel locations

Parameters

Name	Type	Description
salesChannelId	string	Sales channel id
inventoryItemId	string	Item id

Returns

Promise<number>

available quantity of item across all sales channel locations

Defined in

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

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

utils/dist/common/transaction-base-service.d.ts:12

---

withTransaction

▸ withTransaction(transactionManager?): SalesChannelInventoryService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

SalesChannelInventoryService

Inherited from

TransactionBaseService.withTransaction

Defined in

utils/dist/common/transaction-base-service.d.ts:11