Class: ShippingProfileService
Provides layer to manipulate profiles.
Implements
Hierarchy
TransactionBaseService↳
ShippingProfileService
Constructors
constructor
• new ShippingProfileService(__namedParameters)
Parameters
| Name | Type |
|---|---|
__namedParameters | InjectedDependencies |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/shipping-profile.ts:45
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
customShippingOptionService_
• Protected Readonly customShippingOptionService_: CustomShippingOptionService
Defined in
medusa/src/services/shipping-profile.ts:40
manager_
• Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
productRepository_
• Protected Readonly productRepository_: Repository<Product> & { bulkAddToCollection: (productIds: string[], collectionId: string) => Promise<Product[]> ; bulkRemoveFromCollection: (productIds: string[], collectionId: string) => Promise<Product[]> ; findAndCount: (options: ExtendedFindConfig<Product & ProductFilterOptions>, q?: string) => Promise<[Product[], number]> ; findOne: (options: ExtendedFindConfig<Product & ProductFilterOptions>) => Promise<null | Product> ; isProductInSalesChannels: (id: string, salesChannelIds: string[]) => Promise<boolean> ; prepareQueryBuilder_: (options: ExtendedFindConfig<Product & ProductFilterOptions>, q?: string) => Promise<SelectQueryBuilder<Product>> ; upsertShippingProfile: (productIds: string[], shippingProfileId: string) => Promise<Product[]> }
Defined in
medusa/src/services/shipping-profile.ts:43
productService_
• Protected Readonly productService_: ProductService
Defined in
medusa/src/services/shipping-profile.ts:38
shippingOptionService_
• Protected Readonly shippingOptionService_: ShippingOptionService
Defined in
medusa/src/services/shipping-profile.ts:39
shippingProfileRepository_
• Protected Readonly shippingProfileRepository_: Repository<ShippingProfile>
Defined in
medusa/src/services/shipping-profile.ts:42
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
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
Methods
addProduct
▸ addProduct(profileId, productId): Promise<ShippingProfile>
Adds a product of an array of products to the profile.
Parameters
| Name | Type | Description |
|---|---|---|
profileId | string | the profile to add the products to. |
productId | string | string[] | the ID of the product or multiple products to add. |
Returns
Promise<ShippingProfile>
the result of update
Defined in
medusa/src/services/shipping-profile.ts:355
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
| Name | Type | Description |
|---|---|---|
profileId | string | the profile to apply the shipping option to |
optionId | string | 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
medusa/src/services/shipping-profile.ts:385
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
medusa/src/interfaces/transaction-base-service.ts:56
create
▸ create(profile): Promise<ShippingProfile>
Creates a new shipping profile.
Parameters
| Name | Type | Description |
|---|---|---|
profile | CreateShippingProfile | the shipping profile to create from |
Returns
Promise<ShippingProfile>
the result of the create operation
Defined in
medusa/src/services/shipping-profile.ts:249
createDefault
▸ createDefault(): Promise<ShippingProfile>
Creates a default shipping profile, if this does not already exist.
Returns
Promise<ShippingProfile>
the shipping profile
Defined in
medusa/src/services/shipping-profile.ts:179
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
medusa/src/services/shipping-profile.ts:223
delete
▸ delete(profileId): Promise<void>
Deletes a profile with a given profile id.
Parameters
| Name | Type | Description |
|---|---|---|
profileId | string | the id of the profile to delete. Must be castable as an ObjectId |
Returns
Promise<void>
the result of the delete operation.
Defined in
medusa/src/services/shipping-profile.ts:330
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
| Name | Type | Description |
|---|---|---|
cart | any | the cart object to find shipping options for |
Returns
Promise<ShippingOption[]>
a list of the available shipping options
Defined in
medusa/src/services/shipping-profile.ts:415
fetchOptionsByProductIds
▸ fetchOptionsByProductIds(productIds, filter): Promise<ShippingOption[]>
Parameters
| Name | Type |
|---|---|
productIds | string[] |
filter | Selector<ShippingOption> |
Returns
Promise<ShippingOption[]>
Defined in
medusa/src/services/shipping-profile.ts:82
getProfilesInCart
▸ Protected getProfilesInCart(cart): string[]
Returns a list of all the productIds in the cart.
Parameters
| Name | Type | Description |
|---|---|---|
cart | Cart | the cart to extract products from |
Returns
string[]
a list of product ids
Defined in
medusa/src/services/shipping-profile.ts:481
list
▸ list(selector?, config?): Promise<ShippingProfile[]>
Parameters
| Name | Type | Description |
|---|---|---|
selector | Selector<ShippingProfile> | the query object for find |
config | FindConfig<ShippingProfile> | the config object for find |
Returns
Promise<ShippingProfile[]>
the result of the find operation
Defined in
medusa/src/services/shipping-profile.ts:67
retrieve
▸ retrieve(profileId, options?): Promise<ShippingProfile>
Gets a profile by id. Throws in case of DB Error and if profile was not found.
Parameters
| Name | Type | Description |
|---|---|---|
profileId | string | the id of the profile to get. |
options | FindConfig<ShippingProfile> | options opf the query. |
Returns
Promise<ShippingProfile>
the profile document.
Defined in
medusa/src/services/shipping-profile.ts:134
retrieveDefault
▸ retrieveDefault(): Promise<null | ShippingProfile>
Returns
Promise<null | ShippingProfile>
Defined in
medusa/src/services/shipping-profile.ts:163
retrieveGiftCardDefault
▸ retrieveGiftCardDefault(): Promise<null | ShippingProfile>
Retrieves the default gift card profile
Returns
Promise<null | ShippingProfile>
the shipping profile for gift cards
Defined in
medusa/src/services/shipping-profile.ts:206
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err | Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
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
| Name | Type | Description |
|---|---|---|
profileId | string | the id of the profile. Must be a string that can be casted to an ObjectId |
update | UpdateShippingProfile | an object with the update values. |
Returns
Promise<ShippingProfile>
resolves to the update result.
Defined in
medusa/src/services/shipping-profile.ts:284
withTransaction
▸ withTransaction(transactionManager?): ShippingProfileService
Parameters
| Name | Type |
|---|---|
transactionManager? | EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction