Class: ShippingOptionService
Provides layer to manipulate profiles.
Hierarchy
TransactionBaseService↳
ShippingOptionService
Constructors
constructor
• new ShippingOptionService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters | InjectedDependencies |
Overrides
TransactionBaseService.constructor
Defined in
packages/medusa/src/services/shipping-option.ts:55
Properties
__configModule__
• Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
__moduleDeclaration__
• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:11
featureFlagRouter_
• Protected Readonly featureFlagRouter_: FlagRouter
Defined in
packages/medusa/src/services/shipping-option.ts:50
manager_
• Protected manager_: EntityManager
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/shipping-option.ts:52
methodRepository_
• Protected Readonly methodRepository_: typeof ShippingMethodRepository
Defined in
packages/medusa/src/services/shipping-option.ts:49
optionRepository_
• Protected Readonly optionRepository_: typeof ShippingOptionRepository
Defined in
packages/medusa/src/services/shipping-option.ts:48
providerService_
• Protected Readonly providerService_: FulfillmentProviderService
Defined in
packages/medusa/src/services/shipping-option.ts:44
regionService_
• Protected Readonly regionService_: RegionService
Defined in
packages/medusa/src/services/shipping-option.ts:45
requirementRepository_
• Protected Readonly requirementRepository_: typeof ShippingOptionRequirementRepository
Defined in
packages/medusa/src/services/shipping-option.ts:47
transactionManager_
• Protected transactionManager_: undefined | EntityManager
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/shipping-option.ts:53
Methods
addRequirement
▸ addRequirement(optionId, requirement): Promise<ShippingOption>
Adds a requirement to a shipping option. Only 1 requirement of each type is allowed.
Parameters
| Name | Type | Description |
|---|---|---|
optionId | string | the option to add the requirement to. |
requirement | ShippingOptionRequirement | the requirement for the option. |
Returns
Promise<ShippingOption>
the result of update
Defined in
packages/medusa/src/services/shipping-option.ts:713
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.
Type parameters
| Name |
|---|
TResult |
TError |
Parameters
| Name | Type | Description |
|---|---|---|
work | (transactionManager: EntityManager) => Promise<TResult> | the 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<TResult>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:50
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 | Type | Description |
|---|---|---|
data | CreateShippingOptionInput | the data to create shipping options |
Returns
Promise<ShippingOption>
the result of the create operation
Defined in
packages/medusa/src/services/shipping-option.ts:451
createShippingMethod
▸ createShippingMethod(optionId, data, config): Promise<ShippingMethod>
Creates a shipping method for a given cart.
Parameters
| Name | Type | Description |
|---|---|---|
optionId | string | the id of the option to use for the method. |
data | Record<string, unknown> | the optional provider data to use. |
config | CreateShippingMethodDto | the cart to create the shipping method for. |
Returns
Promise<ShippingMethod>
the resulting shipping method.
Defined in
packages/medusa/src/services/shipping-option.ts:278
delete
▸ delete(optionId): Promise<void | ShippingOption>
Deletes a profile with a given profile id.
Parameters
| Name | Type | Description |
|---|---|---|
optionId | string | the id of the profile to delete. Must be castable as an ObjectId |
Returns
Promise<void | ShippingOption>
the result of the delete operation.
Defined in
packages/medusa/src/services/shipping-option.ts:691
deleteShippingMethods
▸ deleteShippingMethods(shippingMethods): Promise<ShippingMethod[]>
Removes a given shipping method
Parameters
| Name | Type | Description |
|---|---|---|
shippingMethods | ShippingMethod | ShippingMethod[] | the shipping method to remove |
Returns
Promise<ShippingMethod[]>
removed shipping methods
Defined in
packages/medusa/src/services/shipping-option.ts:258
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 | Type | Description |
|---|---|---|
option | ShippingOption | the shipping option to retrieve the price for. |
data | Record<string, unknown> | the shipping data to retrieve the price. |
cart | undefined | Cart | Order | the context in which the price should be retrieved. |
Returns
Promise<number>
the price of the shipping option.
Defined in
packages/medusa/src/services/shipping-option.ts:791
list
▸ list(selector, config?): Promise<ShippingOption[]>
Parameters
| Name | Type | Description |
|---|---|---|
selector | Selector<ShippingMethod> | the query object for find |
config | FindConfig<ShippingOption> | config object |
Returns
Promise<ShippingOption[]>
the result of the find operation
Defined in
packages/medusa/src/services/shipping-option.ts:148
listAndCount
▸ listAndCount(selector, config?): Promise<[ShippingOption[], number]>
Parameters
| Name | Type | Description |
|---|---|---|
selector | Selector<ShippingOption> | the query object for find |
config | FindConfig<ShippingOption> | config object |
Returns
Promise<[ShippingOption[], number]>
the result of the find operation
Defined in
packages/medusa/src/services/shipping-option.ts:164
removeRequirement
▸ removeRequirement(requirementId): Promise<void | ShippingOptionRequirement>
Removes a requirement from a shipping option
Parameters
| Name | Type | Description |
|---|---|---|
requirementId | any | the id of the requirement to remove |
Returns
Promise<void | ShippingOptionRequirement>
the result of update
Defined in
packages/medusa/src/services/shipping-option.ts:742
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 | Type | Description |
|---|---|---|
optionId | any | the id of the profile to get. |
options | Object | the options to get a profile |
options.relations? | string[] | - |
options.select? | keyof ShippingOption[] | - |
Returns
Promise<ShippingOption>
the profile document.
Defined in
packages/medusa/src/services/shipping-option.ts:182
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err | Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:31
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 | Type | Description |
|---|---|---|
optionId | string | the id of the option. Must be a string that can be casted to an ObjectId |
update | UpdateShippingOptionInput | an object with the update values. |
Returns
Promise<ShippingOption>
resolves to the update result.
Defined in
packages/medusa/src/services/shipping-option.ts:579
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 | Type | Description |
|---|---|---|
id | string | the id of the shipping method to update |
update | ShippingMethodUpdate | the values to update the method with |
Returns
Promise<undefined | ShippingMethod>
the resulting shipping method
Defined in
packages/medusa/src/services/shipping-option.ts:229
updateShippingProfile
▸ updateShippingProfile(optionIds, profileId): Promise<ShippingOption[]>
Parameters
| Name | Type | Description |
|---|---|---|
optionIds | string | string[] | ID or IDs of the shipping options to update |
profileId | string | Shipping profile ID to update the shipping options with |
Returns
Promise<ShippingOption[]>
updated shipping options
Defined in
packages/medusa/src/services/shipping-option.ts:767
validateAndMutatePrice
▸ Private validateAndMutatePrice(option, priceInput): Promise<CreateShippingOptionInput | Omit<ShippingOption, "beforeInsert">>
Parameters
| Name | Type |
|---|---|
option | ShippingOption | CreateShippingOptionInput |
priceInput | ValidatePriceTypeAndAmountInput |
Returns
Promise<CreateShippingOptionInput | Omit<ShippingOption, "beforeInsert">>
Defined in
packages/medusa/src/services/shipping-option.ts:408
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 | Type | Description |
|---|---|---|
option | ShippingOption | the option object to check |
cart | Cart | the cart object to check against |
Returns
Promise<null | ShippingOption>
the validated shipping option
Defined in
packages/medusa/src/services/shipping-option.ts:366
validatePriceType_
▸ validatePriceType_(priceType, option): Promise<ShippingOptionPriceType>
Validates a shipping option price
Parameters
| Name | Type | Description |
|---|---|---|
priceType | ShippingOptionPriceType | the price to validate |
option | ShippingOption | the option to validate against |
Returns
Promise<ShippingOptionPriceType>
the validated price
Defined in
packages/medusa/src/services/shipping-option.ts:539
validateRequirement_
▸ validateRequirement_(requirement, optionId?): Promise<ShippingOptionRequirement>
Validates a requirement
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
requirement | ShippingOptionRequirement | undefined | the requirement to validate |
optionId | undefined | string | undefined | the id to validate the requirement |
Returns
Promise<ShippingOptionRequirement>
a validated shipping requirement
Defined in
packages/medusa/src/services/shipping-option.ts:82
withTransaction
▸ withTransaction(transactionManager?): ShippingOptionService
Parameters
| Name | Type |
|---|---|
transactionManager? | EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:14