medusa-store/docs/content/references/services/classes/ShippingOptionService.md

Class: ShippingOptionService

Hierarchy

• TransactionBaseService<ShippingOptionService>

  ↳ ShippingOptionService

Constructors

constructor

• new ShippingOptionService(__namedParameters)

Parameters

Name	Type
__namedParameters	Object

Overrides

TransactionBaseService<ShippingOptionService&gt;.constructor

Defined in

services/shipping-option.ts:39

Properties

configModule

• Protected Optional Readonly configModule: Record<string, unknown>

Inherited from

TransactionBaseService.configModule

---

container

• Protected Readonly container: unknown

Inherited from

TransactionBaseService.container

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

services/shipping-option.ts:36

---

methodRepository_

• Protected Readonly methodRepository_: typeof ShippingMethodRepository

Defined in

services/shipping-option.ts:34

---

optionRepository_

• Protected Readonly optionRepository_: typeof ShippingOptionRepository

Defined in

services/shipping-option.ts:33

---

providerService_

• Protected Readonly providerService_: FulfillmentProviderService

Defined in

services/shipping-option.ts:30

---

regionService_

• Protected Readonly regionService_: RegionService

Defined in

services/shipping-option.ts:31

---

requirementRepository_

• Protected Readonly requirementRepository_: typeof ShippingOptionRequirementRepository

Defined in

services/shipping-option.ts:32

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

services/shipping-option.ts:37

Methods

addRequirement

▸ addRequirement(optionId, requirement): Promise<ShippingOption>

Parameters

Name	Type	Description
optionId	string
requirement	ShippingOptionRequirement

Returns

Promise<ShippingOption>

Defined in

services/shipping-option.ts:627

---

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Type parameters

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

Inherited from

TransactionBaseService.atomicPhase_

Defined in

interfaces/transaction-base-service.ts:53

---

create

▸ create(data): Promise<ShippingOption>

Parameters

Name	Type	Description
data	CreateShippingOptionInput

Returns

Promise<ShippingOption>

Defined in

services/shipping-option.ts:384

---

createShippingMethod

▸ createShippingMethod(optionId, data, config): Promise<ShippingMethod>

Parameters

Name	Type	Description
optionId	string
data	object
config	CreateShippingMethodDto

Returns

Promise<ShippingMethod>

Defined in

services/shipping-option.ts:259

---

delete

▸ delete(optionId): Promise<void | ShippingOption>

Parameters

Name	Type	Description
optionId	string

Returns

Promise<void | ShippingOption>

Defined in

services/shipping-option.ts:605

---

deleteShippingMethods

▸ deleteShippingMethods(shippingMethods): Promise<ShippingMethod[]>

Parameters

Name	Type	Description
shippingMethods	ShippingMethod | ShippingMethod[]

Returns

Promise<ShippingMethod[]>

Defined in

services/shipping-option.ts:239

---

getPrice_

▸ getPrice_(option, data, cart): Promise<number>

Parameters

Name	Type	Description
option	ShippingOption
data	object
cart	undefined | Order | Cart

Returns

Promise<number>

Defined in

services/shipping-option.ts:686

---

list

▸ list(selector, config?): Promise<ShippingOption[]>

Parameters

Name	Type	Description
selector	Selector<ShippingMethod>
config	FindConfig<ShippingOption>

Returns

Promise<ShippingOption[]>

Defined in

services/shipping-option.ts:130

---

listAndCount

▸ listAndCount(selector, config?): Promise<[ShippingOption[], number]>

Parameters

Name	Type	Description
selector	Selector<ShippingMethod>
config	FindConfig<ShippingOption>

Returns

Promise<[ShippingOption[], number]>

Defined in

services/shipping-option.ts:149

---

removeRequirement

▸ removeRequirement(requirementId): Promise<void | ShippingOptionRequirement>

Parameters

Name	Type	Description
requirementId	any

Returns

Promise<void | ShippingOptionRequirement>

Defined in

services/shipping-option.ts:656

---

retrieve

▸ retrieve(optionId, options?): Promise<ShippingOption>

Parameters

Name	Type	Description
optionId	any
options	Object
options.relations?	string[]	-
options.select?	keyof ShippingOption[]	-

Returns

Promise<ShippingOption>

Defined in

services/shipping-option.ts:170

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

interfaces/transaction-base-service.ts:34

---

update

▸ update(optionId, update): Promise<ShippingOption>

Parameters

Name	Type	Description
optionId	string
update	UpdateShippingOptionInput

Returns

Promise<ShippingOption>

Defined in

services/shipping-option.ts:498

---

updateShippingMethod

▸ updateShippingMethod(id, update): Promise<undefined | ShippingMethod>

Parameters

Name	Type	Description
id	string
update	ShippingMethodUpdate

Returns

Promise<undefined | ShippingMethod>

Defined in

services/shipping-option.ts:210

---

validateCartOption

▸ validateCartOption(option, cart): null | ShippingOption

Parameters

Name	Type	Description
option	ShippingOption
cart	Cart

Returns

null | ShippingOption

Defined in

services/shipping-option.ts:337

---

validatePriceType_

▸ validatePriceType_(priceType, option): Promise<ShippingOptionPriceType>

Parameters

Name	Type	Description
priceType	ShippingOptionPriceType
option	ShippingOption

Returns

Promise<ShippingOptionPriceType>

Defined in

services/shipping-option.ts:462

---

validateRequirement_

▸ validateRequirement_(requirement, optionId?): Promise<ShippingOptionRequirement>

Parameters

Name	Type	Default value	Description
requirement	ShippingOptionRequirement	undefined
optionId	undefined | string	undefined

Returns

Promise<ShippingOptionRequirement>

Defined in

services/shipping-option.ts:64

---

withTransaction

▸ withTransaction(transactionManager?): ShippingOptionService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

ShippingOptionService

Inherited from

TransactionBaseService.withTransaction

Defined in

interfaces/transaction-base-service.ts:16