Class: SalesChannelInventoryService
Hierarchy
TransactionBaseServiceCopy to Clipboard↳
SalesChannelInventoryServiceCopy to Clipboard
Constructors
constructor
• new SalesChannelInventoryService(__namedParametersCopy to Clipboard)
Parameters
| Name | Type |
|---|---|
__namedParametersCopy to Clipboard | InjectedDependenciesCopy to Clipboard |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/sales-channel-inventory.ts:18
Properties
__configModule__
• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
Inherited from
TransactionBaseService.__configModule__
Defined in
medusa/src/interfaces/transaction-base-service.ts:14
__container__
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__moduleDeclaration__
• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
medusa/src/interfaces/transaction-base-service.ts:15
eventBusService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard eventBusService_: IEventBusServiceCopy to Clipboard
Defined in
medusa/src/services/sales-channel-inventory.ts:15
inventoryService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard inventoryService_: IInventoryServiceCopy to Clipboard
Defined in
medusa/src/services/sales-channel-inventory.ts:16
manager_
• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
salesChannelLocationService_
• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard salesChannelLocationService_: SalesChannelLocationServiceCopy to Clipboard
Defined in
medusa/src/services/sales-channel-inventory.ts:14
transactionManager_
• ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
Accessors
activeManager_
• ProtectedCopy to Clipboard getCopy to Clipboard activeManager_(): EntityManagerCopy to Clipboard
Returns
EntityManagerCopy to Clipboard
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
Methods
atomicPhase_
▸ ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>
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 |
|---|
TResultCopy to Clipboard |
TErrorCopy to Clipboard |
Parameters
| Name | Type | Description |
|---|---|---|
workCopy to Clipboard | (transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard> | the transactional work to be done |
isolationOrErrorHandler?Copy to Clipboard | IsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard> | the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail?Copy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard> | Potential error handler |
Returns
PromiseCopy to Clipboard<TResultCopy to Clipboard>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
medusa/src/interfaces/transaction-base-service.ts:56
retrieveAvailableItemQuantity
▸ retrieveAvailableItemQuantity(salesChannelIdCopy to Clipboard, inventoryItemIdCopy to Clipboard): PromiseCopy to Clipboard<numberCopy to Clipboard>
Retrieves the available quantity of an item across all sales channel locations
Parameters
| Name | Type | Description |
|---|---|---|
salesChannelIdCopy to Clipboard | stringCopy to Clipboard | Sales channel id |
inventoryItemIdCopy to Clipboard | stringCopy to Clipboard | Item id |
Returns
PromiseCopy to Clipboard<numberCopy to Clipboard>
available quantity of item across all sales channel locations
Defined in
medusa/src/services/sales-channel-inventory.ts:37
shouldRetryTransaction_
▸ ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard
Parameters
| Name | Type |
|---|---|
errCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard } |
Returns
booleanCopy to Clipboard
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
withTransaction
▸ withTransaction(transactionManager?Copy to Clipboard): SalesChannelInventoryServiceCopy to Clipboard
Parameters
| Name | Type |
|---|---|
transactionManager?Copy to Clipboard | EntityManagerCopy to Clipboard |
Returns
SalesChannelInventoryServiceCopy to Clipboard
Inherited from
TransactionBaseService.withTransaction