Skip to main content
Skip to main content

SalesChannelInventoryService

Constructors

constructor

**new SalesChannelInventoryService**(«destructured»)

Parameters
__namedParametersInjectedDependenciesRequired

Properties

__configModule__Record<string, unknown>
__container__anyRequired
__moduleDeclaration__Record<string, unknown>
eventBusService_IEventBusServiceRequired
manager_EntityManagerRequired
salesChannelLocationService_SalesChannelLocationServiceRequired
transactionManager_undefined | EntityManagerRequired

Accessors

activeManager_

Protected activeManager_: [object Object]


inventoryService_

Protected inventoryService_: [object Object]

Methods

atomicPhase_

Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;

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

retrieveAvailableItemQuantity

**retrieveAvailableItemQuantity**(salesChannelId, inventoryItemId): Promise&#60;number&#62;

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

withTransaction

**withTransaction**(transactionManager?): [SalesChannelInventoryService](/references/services/classes/SalesChannelInventoryService)

Parameters
transactionManagerEntityManager
Returns

SalesChannelInventoryService

SalesChannelInventoryServiceSalesChannelInventoryServiceRequired
Was this section helpful?