Skip to main content
Skip to main content

SalesChannelLocationService

Service for managing the stock locations of sales channels

constructor​

Parameters​

__namedParametersInjectedDependenciesRequired

Properties​

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

Accessors​

activeManager_​

Returns​

EntityManagerEntityManagerRequired

stockLocationService_​

Returns​

IStockLocationServiceobjectRequired

Methods​

associateLocation​

Associates a sales channel with a stock location.

Parameters​

salesChannelIdstringRequired
The ID of the sales channel.
locationIdstringRequired
The ID of the stock location.

Returns​

PromisePromise<void>Required
A promise that resolves when the association has been created.

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

listLocationIds​

Lists the stock locations associated with a sales channel.

Parameters​

salesChannelIdstring | string[]Required
The ID of the sales channel.

Returns​

PromisePromise<string[]>Required
A promise that resolves with an array of location IDs.

listSalesChannelIds​

Lists the sales channels associated with a stock location.

Parameters​

locationIdstringRequired

Returns​

PromisePromise<string[]>Required
A promise that resolves with an array of sales channel IDs.

removeLocation​

Removes an association between a sales channel and a stock location.

Parameters​

locationIdstringRequired
The ID of the stock location.
salesChannelIdstring
The ID of the sales channel or undefined if all the sales channel will be affected.

Returns​

PromisePromise<void>Required
A promise that resolves when the association has been removed.

shouldRetryTransaction_​

Parameters​

errRecord<string, unknown> | objectRequired

Returns​

booleanboolean

withTransaction​

Parameters​

transactionManagerEntityManager

Returns​

SalesChannelLocationServiceobjectRequired
Service for managing the stock locations of sales channels
Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.