Skip to main content

Class: ShippingProfileService

Provides layer to manipulate profiles.

Implements

Hierarchy

  • TransactionBaseService

    ShippingProfileService

Constructors

constructor

new ShippingProfileService(__namedParameters)

Parameters

NameType
__namedParametersInjectedDependencies

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/shipping-profile.ts:48

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


customShippingOptionService_

Protected Readonly customShippingOptionService_: CustomShippingOptionService

Defined in

packages/medusa/src/services/shipping-profile.ts:40


manager_

Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/shipping-profile.ts:45


productRepository_

Protected Readonly productRepository_: typeof ProductRepository

Defined in

packages/medusa/src/services/shipping-profile.ts:43


productService_

Protected Readonly productService_: ProductService

Defined in

packages/medusa/src/services/shipping-profile.ts:38


shippingOptionService_

Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

packages/medusa/src/services/shipping-profile.ts:39


shippingProfileRepository_

Protected Readonly shippingProfileRepository_: typeof ShippingProfileRepository

Defined in

packages/medusa/src/services/shipping-profile.ts:42


transactionManager_

Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/shipping-profile.ts:46

Methods

addProduct

addProduct(profileId, productId): Promise<ShippingProfile>

Adds a product of an array of products to the profile.

Parameters

NameTypeDescription
profileIdstringthe profile to add the products to.
productIdstring | string[]the ID of the product or multiple products to add.

Returns

Promise<ShippingProfile>

the result of update

Defined in

packages/medusa/src/services/shipping-profile.ts:356


addShippingOption

addShippingOption(profileId, optionId): Promise<ShippingProfile>

Adds a shipping option to the profile. The shipping option can be used to fulfill the products in the products field.

Parameters

NameTypeDescription
profileIdstringthe profile to apply the shipping option to
optionIdstring | string[]the ID of the option or multiple options to add to the profile

Returns

Promise<ShippingProfile>

the result of the model update operation

Defined in

packages/medusa/src/services/shipping-profile.ts:386


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

NameTypeDescription
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(profile): Promise<ShippingProfile>

Creates a new shipping profile.

Parameters

NameTypeDescription
profileCreateShippingProfilethe shipping profile to create from

Returns

Promise<ShippingProfile>

the result of the create operation

Defined in

packages/medusa/src/services/shipping-profile.ts:250


createDefault

createDefault(): Promise<ShippingProfile>

Creates a default shipping profile, if this does not already exist.

Returns

Promise<ShippingProfile>

the shipping profile

Defined in

packages/medusa/src/services/shipping-profile.ts:180


createGiftCardDefault

createGiftCardDefault(): Promise<ShippingProfile>

Creates a default shipping profile, for gift cards if unless it already exists.

Returns

Promise<ShippingProfile>

the shipping profile

Defined in

packages/medusa/src/services/shipping-profile.ts:224


delete

delete(profileId): Promise<void>

Deletes a profile with a given profile id.

Parameters

NameTypeDescription
profileIdstringthe id of the profile to delete. Must be castable as an ObjectId

Returns

Promise<void>

the result of the delete operation.

Defined in

packages/medusa/src/services/shipping-profile.ts:331


fetchCartOptions

fetchCartOptions(cart): Promise<ShippingOption[]>

Finds all the shipping profiles that cover the products in a cart, and validates all options that are available for the cart.

Parameters

NameTypeDescription
cartanythe cart object to find shipping options for

Returns

Promise<ShippingOption[]>

a list of the available shipping options

Defined in

packages/medusa/src/services/shipping-profile.ts:416


fetchOptionsByProductIds

fetchOptionsByProductIds(productIds, filter): Promise<ShippingOption[]>

Parameters

NameType
productIdsstring[]
filterSelector<ShippingOption>

Returns

Promise<ShippingOption[]>

Defined in

packages/medusa/src/services/shipping-profile.ts:83


getProfilesInCart

Protected getProfilesInCart(cart): string[]

Returns a list of all the productIds in the cart.

Parameters

NameTypeDescription
cartCartthe cart to extract products from

Returns

string[]

a list of product ids

Defined in

packages/medusa/src/services/shipping-profile.ts:482


list

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

Parameters

NameTypeDescription
selectorSelector<ShippingProfile>the query object for find
configFindConfig<ShippingProfile>the config object for find

Returns

Promise<ShippingProfile[]>

the result of the find operation

Defined in

packages/medusa/src/services/shipping-profile.ts:71


retrieve

retrieve(profileId, options?): Promise<ShippingProfile>

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

Parameters

NameTypeDescription
profileIdstringthe id of the profile to get.
optionsFindConfig<ShippingProfile>options opf the query.

Returns

Promise<ShippingProfile>

the profile document.

Defined in

packages/medusa/src/services/shipping-profile.ts:135


retrieveDefault

retrieveDefault(): Promise<undefined | ShippingProfile>

Returns

Promise<undefined | ShippingProfile>

Defined in

packages/medusa/src/services/shipping-profile.ts:164


retrieveGiftCardDefault

retrieveGiftCardDefault(): Promise<undefined | ShippingProfile>

Retrieves the default gift card profile

Returns

Promise<undefined | ShippingProfile>

the shipping profile for gift cards

Defined in

packages/medusa/src/services/shipping-profile.ts:207


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

NameType
errRecord<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:31


update

update(profileId, update): Promise<ShippingProfile>

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

Parameters

NameTypeDescription
profileIdstringthe id of the profile. Must be a string that can be casted to an ObjectId
updateUpdateShippingProfilean object with the update values.

Returns

Promise<ShippingProfile>

resolves to the update result.

Defined in

packages/medusa/src/services/shipping-profile.ts:285


withTransaction

withTransaction(transactionManager?): ShippingProfileService

Parameters

NameType
transactionManager?EntityManager

Returns

ShippingProfileService

Inherited from

TransactionBaseService.withTransaction

Defined in

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