SalesChannelInventoryService

internal.internal.SalesChannelInventoryService

Properties

__configModule__Record<string, unknown>

__container__anyRequired

__moduleDeclaration__Record<string, unknown>

eventBusService_IEventBusServiceRequired

inventoryService_IInventoryServiceRequired

manager_EntityManagerRequired

salesChannelLocationService_SalesChannelLocationServiceRequired

transactionManager_undefined | EntityManagerRequired

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

EntityManagerEntityManagerRequired

Inherited from

TransactionBaseService.activeManager_

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.

TResultobjectRequired

TErrorobjectRequired

Parameters

work(transactionManager: EntityManager) => Promise<TResult>Required

the transactional work to be done

isolationOrErrorHandlerIsolationLevel | (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>

PromisePromise<TResult>Required

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

---

retrieveAvailableItemQuantity

retrieveAvailableItemQuantity(salesChannelId, inventoryItemId): Promise<number>

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

Parameters

salesChannelIdstringRequired

Sales channel id

inventoryItemIdstringRequired

Item id

Returns

Promise<number>

PromisePromise<number>Required

available quantity of item across all sales channel locations

---

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

errRecord<string, unknown> | { code: string }Required

Returns

boolean

booleanboolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

---

withTransaction

withTransaction(transactionManager?): SalesChannelInventoryService

Parameters

transactionManagerEntityManager

Returns

SalesChannelInventoryService

SalesChannelInventoryServiceSalesChannelInventoryServiceRequired

Inherited from

TransactionBaseService.withTransaction