medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.ShippingProfileService.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: ShippingProfileService

internal.internal.ShippingProfileService

Provides layer to manipulate profiles.

Implements

Hierarchy

• TransactionBaseService

  ↳ ShippingProfileService

Properties

__configModule__

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

Inherited from

TransactionBaseService.configModule

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:5

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.container

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:4

---

__moduleDeclaration__

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

Inherited from

TransactionBaseService.moduleDeclaration

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:6

---

customShippingOptionService_

• Protected Readonly customShippingOptionService_: CustomShippingOptionService

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:29

---

featureFlagRouter_

• Protected Readonly featureFlagRouter_: FlagRouter

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:32

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:7

---

productRepository_

• Protected Readonly productRepository_: Repository<Product> & { _applyCategoriesQuery: (qb: SelectQueryBuilder<Product>, __namedParameters: { alias: any ; categoryAlias: any ; joinName: any ; where: any }) => SelectQueryBuilder<Product> ; _findWithRelations: (__namedParameters: { idsOrOptionsWithoutRelations: string[] | FindWithoutRelationsOptions ; relations: string[] ; shouldCount: boolean ; withDeleted: boolean }) => Promise<[Product[], number]> ; bulkAddToCollection: (productIds: string[], collectionId: string) => Promise<Product[]> ; bulkRemoveFromCollection: (productIds: string[], collectionId: string) => Promise<Product[]> ; findOneWithRelations: (relations?: string[], optionsWithoutRelations?: FindWithoutRelationsOptions) => Promise<Product> ; findWithRelations: (relations?: string[], idsOrOptionsWithoutRelations?: string[] | FindWithoutRelationsOptions, withDeleted?: boolean) => Promise<Product[]> ; findWithRelationsAndCount: (relations?: string[], idsOrOptionsWithoutRelations?: FindWithoutRelationsOptions) => Promise<[Product[], number]> ; getCategoryIdsFromInput: (categoryId?: CategoryQueryParams, includeCategoryChildren?: boolean) => Promise<string[]> ; getCategoryIdsRecursively: (productCategory: ProductCategory) => string[] ; getFreeTextSearchResultsAndCount: (q: string, options?: FindWithoutRelationsOptions, relations?: string[]) => Promise<[Product[], number]> ; isProductInSalesChannels: (id: string, salesChannelIds: string[]) => Promise<boolean> ; queryProducts: (optionsWithoutRelations: FindWithoutRelationsOptions, shouldCount?: boolean) => Promise<[Product[], number]> ; queryProductsWithIds: (__namedParameters: { entityIds: string[] ; groupedRelations: { [toplevel: string]: string[]; } ; order?: { [column: string]: "ASC" | "DESC"; } ; select?: keyof Product[] ; where?: FindOptionsWhere<Product> ; withDeleted?: boolean }) => Promise<Product[]> }

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:31

---

productService_

• Protected Readonly productService_: ProductService

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:27

---

shippingOptionService_

• Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:28

---

shippingProfileRepository_

• Protected Readonly shippingProfileRepository_: Repository<ShippingProfile> & { findByProducts: (productIds: string | string[]) => Promise<{ [product_id: string]: ShippingProfile[]; }> }

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:30

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:8

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:9

Methods

addProduct

▸ addProduct(profileId, productId): Promise<ShippingProfile>

Parameters

Name	Type
profileId	string
productId	string | string[]

Returns

Promise<ShippingProfile>

Deprecated

use addProducts instead

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:95

---

addProducts

▸ addProducts(profileId, productId): Promise<ShippingProfile>

Adds a product or 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

packages/medusa/dist/services/shipping-profile.d.ts:102

---

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

packages/medusa/dist/services/shipping-profile.d.ts:117

---

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/dist/interfaces/transaction-base-service.d.ts:24

---

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

packages/medusa/dist/services/shipping-profile.d.ts:74

---

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/dist/services/shipping-profile.d.ts:57

---

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/dist/services/shipping-profile.d.ts:68

---

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

packages/medusa/dist/services/shipping-profile.d.ts:91

---

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

packages/medusa/dist/services/shipping-profile.d.ts:124

---

getMapProfileIdsByProductIds

▸ getMapProfileIdsByProductIds(productIds): Promise<Map<string, string>>

Parameters

Name	Type
productIds	string[]

Returns

Promise<Map<string, string>>

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:40

---

getProfilesInCart

▸ Protected getProfilesInCart(cart): Promise<string[]>

Returns a list of all the productIds in the cart.

Parameters

Name	Type	Description
cart	Cart	the cart to extract products from

Returns

Promise<string[]>

a list of product ids

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:130

---

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

packages/medusa/dist/services/shipping-profile.d.ts:39

---

removeProducts

▸ removeProducts(profileId, productId): Promise<void | ShippingProfile>

Removes a product or an array of products from the profile.

Parameters

Name	Type	Description
profileId	null | string	the profile to add the products to.
productId	string | string[]	the ID of the product or multiple products to add.

Returns

Promise<void | ShippingProfile>

the result of update

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:109

---

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

packages/medusa/dist/services/shipping-profile.d.ts:48

---

retrieveDefault

▸ retrieveDefault(): Promise<null | ShippingProfile>

Returns

Promise<null | ShippingProfile>

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:52

---

retrieveForProducts

▸ retrieveForProducts(productIds): Promise<{ [product_id: string]: ShippingProfile[]; }>

Parameters

Name	Type
productIds	string | string[]

Returns

Promise<{ [product_id: string]: ShippingProfile[]; }>

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:49

---

retrieveGiftCardDefault

▸ retrieveGiftCardDefault(): Promise<null | ShippingProfile>

Retrieves the default gift card profile

Returns

Promise<null | ShippingProfile>

the shipping profile for gift cards

Defined in

packages/medusa/dist/services/shipping-profile.d.ts:62

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:12

---

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

packages/medusa/dist/services/shipping-profile.d.ts:84

---

withTransaction

▸ withTransaction(transactionManager?): ShippingProfileService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

ShippingProfileService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:11