ShippingOptionService

Provides layer to manipulate profiles.

Hierarchy

• TransactionBaseService

  ↳ ShippingOptionService

Constructors

constructor

new ShippingOptionService(«destructured»)

Parameters

Name
«destructured»

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/shipping-option.ts:52

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

medusa/src/interfaces/transaction-base-service.ts:14

---

__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13

---

__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

---

featureFlagRouter_

Protected Readonly featureFlagRouter_: FlagRouter

Defined in

medusa/src/services/shipping-option.ts:50

---

manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

---

methodRepository_

Protected Readonly methodRepository_: Repository<ShippingMethod>

Defined in

medusa/src/services/shipping-option.ts:49

---

optionRepository_

Protected Readonly optionRepository_: Repository<ShippingOption> & { upsertShippingProfile: Method upsertShippingProfile }

Defined in

medusa/src/services/shipping-option.ts:48

---

providerService_

Protected Readonly providerService_: FulfillmentProviderService

Defined in

medusa/src/services/shipping-option.ts:44

---

regionService_

Protected Readonly regionService_: RegionService

Defined in

medusa/src/services/shipping-option.ts:45

---

requirementRepository_

Protected Readonly requirementRepository_: Repository<ShippingOptionRequirement>

Defined in

medusa/src/services/shipping-option.ts:47

---

transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

-EntityManager:

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

addRequirement

addRequirement(optionId, requirement): Promise<ShippingOption>

Adds a requirement to a shipping option. Only 1 requirement of each type is allowed.

Parameters

Name	Description
optionId	string
requirement	ShippingOptionRequirement

Returns

Promise<ShippingOption>

-Promise: the result of update -ShippingOption:

Defined in

medusa/src/services/shipping-option.ts:693

---

atomicPhase_

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

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.

Name
TResult
TError

Parameters

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

Returns

Promise<TResult>

-Promise: the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

---

create

create(data): Promise<ShippingOption>

Creates a new shipping option. Used both for outbound and inbound shipping options. The difference is registered by the is_return field which defaults to false.

Parameters

Name	Description
data	CreateShippingOptionInput

Returns

Promise<ShippingOption>

-Promise: the result of the create operation -ShippingOption:

Defined in

medusa/src/services/shipping-option.ts:431

---

createShippingMethod

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

Creates a shipping method for a given cart.

Parameters

Name	Description
optionId	string
data	Record<string, unknown>
config	CreateShippingMethodDto

Returns

Promise<ShippingMethod>

-Promise: the resulting shipping method. -ShippingMethod:

Defined in

medusa/src/services/shipping-option.ts:258

---

delete

delete(optionId): Promise<void | ShippingOption>

Deletes a profile with a given profile id.

Parameters

Name	Description
optionId	string

Returns

Promise<void | ShippingOption>

-Promise: the result of the delete operation. -void \| ShippingOption: (optional)

Defined in

medusa/src/services/shipping-option.ts:671

---

deleteShippingMethods

deleteShippingMethods(shippingMethods): Promise<ShippingMethod[]>

Removes a given shipping method

Parameters

Name	Description
shippingMethods	ShippingMethod | ShippingMethod[]

Returns

Promise<ShippingMethod[]>

-Promise: removed shipping methods -ShippingMethod[]: -ShippingMethod:

Defined in

medusa/src/services/shipping-option.ts:238

---

getPrice_

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

Returns the amount to be paid for a shipping method. Will ask the fulfillment provider to calculate the price if the shipping option has the price type "calculated".

Parameters

Name	Description
option	ShippingOption
data	Record<string, unknown>
cart	undefined | Order | Cart

Returns

Promise<number>

-Promise: the price of the shipping option. -number: (optional)

Defined in

medusa/src/services/shipping-option.ts:771

---

list

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

Parameters

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

Returns

Promise<ShippingOption[]>

-Promise: the result of the find operation -ShippingOption[]: -ShippingOption:

Defined in

medusa/src/services/shipping-option.ts:145

---

listAndCount

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

Parameters

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

Returns

Promise<[ShippingOption[], number]>

-Promise: the result of the find operation -ShippingOption[]: -number: (optional)

Defined in

medusa/src/services/shipping-option.ts:160

---

removeRequirement

removeRequirement(requirementId): Promise<void | ShippingOptionRequirement>

Removes a requirement from a shipping option

Parameters

Name	Description
requirementId	any

Returns

Promise<void | ShippingOptionRequirement>

-Promise: the result of update -void \| ShippingOptionRequirement: (optional)

Defined in

medusa/src/services/shipping-option.ts:722

---

retrieve

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

Gets a profile by id. Throws in case of DB Error and if profile was not found.

Parameters

Name	Description
optionId	any
options	FindConfig<ShippingOption>

Returns

Promise<ShippingOption>

-Promise: the profile document. -ShippingOption:

Defined in

medusa/src/services/shipping-option.ts:177

---

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name
err

Returns

boolean

-boolean: (optional)

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

---

update

update(optionId, update): Promise<ShippingOption>

Updates a profile. Metadata updates and product updates should use dedicated methods, e.g. setMetadata, etc. The function will throw errors if metadata or product updates are attempted.

Parameters

Name	Description
optionId	string
update	UpdateShippingOptionInput

Returns

Promise<ShippingOption>

-Promise: resolves to the update result. -ShippingOption:

Defined in

medusa/src/services/shipping-option.ts:559

---

updateShippingMethod

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

Updates a shipping method's associations. Useful when a cart is completed and its methods should be copied to an order/swap entity.

Parameters

Name	Description
id	string
update	ShippingMethodUpdate

Returns

Promise<undefined | ShippingMethod>

-Promise: the resulting shipping method -undefined \| ShippingMethod: (optional)

Defined in

medusa/src/services/shipping-option.ts:211

---

updateShippingProfile

updateShippingProfile(optionIds, profileId): Promise<ShippingOption[]>

Parameters

Name	Description
optionIds	string | string[]
profileId	string

Returns

Promise<ShippingOption[]>

-Promise: updated shipping options -ShippingOption[]: -ShippingOption:

Defined in

medusa/src/services/shipping-option.ts:747

---

validateAndMutatePrice

Private validateAndMutatePrice(option, priceInput): Promise<CreateShippingOptionInput | Omit<ShippingOption, "beforeInsert">>

Parameters

Name
option
priceInput

Returns

Promise<CreateShippingOptionInput | Omit<ShippingOption, "beforeInsert">>

-Promise: -CreateShippingOptionInput \| Omit<ShippingOption, ``"beforeInsert"``\>: (optional)

Defined in

medusa/src/services/shipping-option.ts:388

---

validateCartOption

validateCartOption(option, cart): Promise<null | ShippingOption>

Checks if a given option id is a valid option for a cart. If it is the option is returned with the correct price. Throws when region_ids do not match, or when the shipping option requirements are not satisfied.

Parameters

Name	Description
option	ShippingOption
cart	Cart

Returns

Promise<null | ShippingOption>

-Promise: the validated shipping option -`null | ShippingOption`: (optional)

Defined in

medusa/src/services/shipping-option.ts:346

---

validatePriceType_

validatePriceType_(priceType, option): Promise<ShippingOptionPriceType>

Validates a shipping option price

Parameters

Name	Description
priceType	ShippingOptionPriceType
option	ShippingOption

Returns

Promise<ShippingOptionPriceType>

-Promise: the validated price

Defined in

medusa/src/services/shipping-option.ts:519

---

validateRequirement_

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

Validates a requirement

Parameters

Name	Default value	Description
requirement	ShippingOptionRequirement	the requirement to validate
optionId	undefined | string	undefined

Returns

Promise<ShippingOptionRequirement>

-Promise: a validated shipping requirement -ShippingOptionRequirement:

Defined in

medusa/src/services/shipping-option.ts:77

---

withTransaction

withTransaction(transactionManager?): ShippingOptionService

Parameters

Name
transactionManager?

Returns

ShippingOptionService

-ShippingOptionService:

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20