Skip to main content
Skip to main content
You're viewing the documentation for v1, which isn't the latest Medusa version.Latest documentation

CustomShippingOptionService

constructor​

Parameters​

__namedParametersInjectedDependenciesRequired

Properties​

manager_EntityManagerRequired
transactionManager_undefined | EntityManagerRequired
__container__anyRequired
customShippingOptionRepository_Repository<CustomShippingOption>Required
__configModule__Record<string, unknown>
__moduleDeclaration__Record<string, unknown>

Accessors​

activeManager_​

Returns​

EntityManagerEntityManagerRequired

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

retrieve​

Retrieves a specific shipping option.

Parameters​

idstringRequired
the id of the custom shipping option to retrieve.
any options needed to query for the result.

Default: {}

Returns​

PromisePromise<CustomShippingOption>Required
the requested custom shipping option.

list​

Fetches all custom shipping options based on the given selector

Parameters​

the query object for find
the configuration used to find the objects. contains relations, skip, and take.

Returns​

PromisePromise<CustomShippingOption[]>Required
custom shipping options matching the query

create​

Creates a custom shipping option

Type Parameters​

TobjectRequired
TResultobjectRequired

Parameters​

dataTRequired
the custom shipping option to create

Returns​

PromisePromise<TResult>Required
resolves to the creation result
Was this section helpful?