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 get**activeManager_**(): EntityManager

Returns​

EntityManager

EntityManagerEntityManagerRequired

inventoryService_​

Protected get**inventoryService_**(): [IInventoryService](/references/services/interfaces/IInventoryService)

Returns​

IInventoryService

adjustInventory(inventoryItemId: string, locationId: string, adjustment: number, context?: SharedContext) => Promise<InventoryLevelDTO>Required
confirmInventory(inventoryItemId: string, locationIds: string[], quantity: number, context?: SharedContext) => Promise<boolean>Required
createInventoryItem(input: CreateInventoryItemInput, context?: SharedContext) => Promise<InventoryItemDTO>Required
createInventoryItems(input: CreateInventoryItemInput[], context?: SharedContext) => Promise<InventoryItemDTO[]>Required
createInventoryLevel(data: CreateInventoryLevelInput, context?: SharedContext) => Promise<InventoryLevelDTO>Required
createInventoryLevels(data: CreateInventoryLevelInput[], context?: SharedContext) => Promise<InventoryLevelDTO[]>Required
createReservationItem(input: CreateReservationItemInput, context?: SharedContext) => Promise<ReservationItemDTO>Required
createReservationItems(input: CreateReservationItemInput[], context?: SharedContext) => Promise<ReservationItemDTO[]>Required
deleteInventoryItem(inventoryItemId: string | string[], context?: SharedContext) => Promise<void>Required
deleteInventoryItemLevelByLocationId(locationId: string | string[], context?: SharedContext) => Promise<void>Required
deleteInventoryLevel(inventoryItemId: string, locationId: string, context?: SharedContext) => Promise<void>Required
deleteReservationItem(reservationItemId: string | string[], context?: SharedContext) => Promise<void>Required
deleteReservationItemByLocationId(locationId: string | string[], context?: SharedContext) => Promise<void>Required
deleteReservationItemsByLineItem(lineItemId: string | string[], context?: SharedContext) => Promise<void>Required
listInventoryItems(selector: FilterableInventoryItemProps, config?: FindConfig<InventoryItemDTO>, context?: SharedContext) => Promise<[InventoryItemDTO[], number]>Required
listInventoryLevels(selector: FilterableInventoryLevelProps, config?: FindConfig<InventoryLevelDTO>, context?: SharedContext) => Promise<[InventoryLevelDTO[], number]>Required
listReservationItems(selector: FilterableReservationItemProps, config?: FindConfig<ReservationItemDTO>, context?: SharedContext) => Promise<[ReservationItemDTO[], number]>Required
restoreInventoryItem(inventoryItemId: string | string[], context?: SharedContext) => Promise<void>Required
retrieveAvailableQuantity(inventoryItemId: string, locationIds: string[], context?: SharedContext) => Promise<number>Required
retrieveInventoryItem(inventoryItemId: string, config?: FindConfig<InventoryItemDTO>, context?: SharedContext) => Promise<InventoryItemDTO>Required
retrieveInventoryLevel(inventoryItemId: string, locationId: string, context?: SharedContext) => Promise<InventoryLevelDTO>Required
retrieveReservationItem(reservationId: string, context?: SharedContext) => Promise<ReservationItemDTO>Required
retrieveReservedQuantity(inventoryItemId: string, locationIds: string[], context?: SharedContext) => Promise<number>Required
retrieveStockedQuantity(inventoryItemId: string, locationIds: string[], context?: SharedContext) => Promise<number>Required
updateInventoryItem(inventoryItemId: string, input: Partial<CreateInventoryItemInput>, context?: SharedContext) => Promise<InventoryItemDTO>Required
updateInventoryLevel(inventoryItemId: string, locationId: string, update: UpdateInventoryLevelInput, context?: SharedContext) => Promise<InventoryLevelDTO>Required
updateInventoryLevels(updates: BulkUpdateInventoryLevelInput[], context?: SharedContext) => Promise<InventoryLevelDTO[]>Required
updateReservationItem(reservationItemId: string, input: UpdateReservationItemInput, context?: SharedContext) => Promise<ReservationItemDTO>Required

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.

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?
© 2023 Medusa, Inc. All rights reserved.