Skip to main content
Skip to main content

SalesChannelInventoryService

constructor

Parameters

__namedParametersInjectedDependenciesRequired

Properties

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

Accessors

activeManager_

Returns

EntityManagerEntityManagerRequired

inventoryService_

Returns

IInventoryServiceobjectRequired
The main service interface for the inventory module.

Methods

withTransaction

Parameters

transactionManagerEntityManager

Returns

thisthisRequired

shouldRetryTransaction_

Parameters

errRecord<string, unknown> | objectRequired

Returns

booleanbooleanRequired

atomicPhase_

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

PromisePromise<TResult>Required
the result of the transactional work

retrieveAvailableItemQuantity

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

Parameters

salesChannelIdstringRequired
Sales channel id
inventoryItemIdstringRequired
Item id

Returns

PromisePromise<number>Required
available quantity of item across all sales channel locations
Was this section helpful?