SalesChannelLocationService
Service for managing the stock locations of sales channels
constructor
Parameters
__namedParameters
InjectedDependenciesRequiredProperties
manager_
EntityManagerRequiredtransactionManager_
undefined | EntityManagerRequired__container__
anyRequired__configModule__
Record<string, unknown>__moduleDeclaration__
Record<string, unknown>Accessors
activeManager_
Returns
EntityManager
EntityManagerRequiredstockLocationService_
Returns
IStockLocationService
objectRequiredThe main service interface for the stock location's module.
Methods
withTransaction
Parameters
transactionManager
EntityManagerReturns
this
thisRequiredshouldRetryTransaction_
Parameters
err
Record<string, unknown> | objectRequiredReturns
boolean
booleanRequiredatomicPhase_
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
TResult
objectRequiredTError
objectRequiredParameters
work
(transactionManager: EntityManager) => Promise<TResult>Requiredthe transactional work to be done
isolationOrErrorHandler
IsolationLevel | (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
Promise<TResult>Requiredthe result of the transactional work
removeLocation
Removes an association between a sales channel and a stock location.
Parameters
locationId
stringRequiredThe ID of the stock location.
salesChannelId
stringThe ID of the sales channel or undefined if all the sales channel will be affected.
Returns
Promise
Promise<void>RequiredA promise that resolves when the association has been removed.
associateLocation
Associates a sales channel with a stock location.
Parameters
salesChannelId
stringRequiredThe ID of the sales channel.
locationId
stringRequiredThe ID of the stock location.
Returns
Promise
Promise<void>RequiredA promise that resolves when the association has been created.
listLocationIds
Lists the stock locations associated with a sales channel.
Parameters
salesChannelId
string | string[]RequiredThe ID of the sales channel.
Returns
Promise
Promise<string[]>RequiredA promise that resolves with an array of location IDs.
listSalesChannelIds
Lists the sales channels associated with a stock location.
Parameters
locationId
stringRequiredThe ID of the stock location.
Returns
Promise
Promise<string[]>RequiredA promise that resolves with an array of sales channel IDs.
Was this section helpful?