medusa-store/docs/content/references/services/classes/ProductVariantService.md

Class: ProductVariantService

Hierarchy

• "medusa-interfaces"

  ↳ ProductVariantService

Constructors

constructor

• new ProductVariantService(__namedParameters)

Parameters

Name	Type
__namedParameters	Object

Overrides

BaseService.constructor

Defined in

services/product-variant.ts:52

Properties

cartRepository_

• Private cartRepository_: typeof CartRepository

Defined in

services/product-variant.ts:50

---

eventBus_

• Private eventBus_: EventBusService

Defined in

services/product-variant.ts:45

---

manager_

• Private manager_: EntityManager

Defined in

services/product-variant.ts:42

---

moneyAmountRepository_

• Private moneyAmountRepository_: typeof MoneyAmountRepository

Defined in

services/product-variant.ts:48

---

priceSelectionStrategy_

• Private priceSelectionStrategy_: IPriceSelectionStrategy

Defined in

services/product-variant.ts:47

---

productOptionValueRepository_

• Private productOptionValueRepository_: typeof ProductOptionValueRepository

Defined in

services/product-variant.ts:49

---

productRepository_

• Private productRepository_: typeof ProductRepository

Defined in

services/product-variant.ts:44

---

productVariantRepository_

• Private productVariantRepository_: typeof ProductVariantRepository

Defined in

services/product-variant.ts:43

---

regionService_

• Private regionService_: RegionService

Defined in

services/product-variant.ts:46

---

Events

▪ Static Events: Object

Type declaration

Name	Type
CREATED	string
DELETED	string
UPDATED	string

Defined in

services/product-variant.ts:36

Methods

addOptionValue

▸ addOptionValue(variantId, optionId, optionValue): Promise<ProductOptionValue>

Parameters

Name	Type	Description
variantId	string
optionId	string
optionValue	string

Returns

Promise<ProductOptionValue>

Defined in

services/product-variant.ts:529

---

create

▸ create(productOrProductId, variant): Promise<ProductVariant>

Parameters

Name	Type	Description
productOrProductId	string | Product
variant	CreateProductVariantInput

Returns

Promise<ProductVariant>

Defined in

services/product-variant.ts:183

---

delete

▸ delete(variantId): Promise<void>

Parameters

Name	Type	Description
variantId	string

Returns

Promise<void>

Defined in

services/product-variant.ts:682

---

deleteOptionValue

▸ deleteOptionValue(variantId, optionId): Promise<void>

Parameters

Name	Type	Description
variantId	string
optionId	string

Returns

Promise<void>

Defined in

services/product-variant.ts:556

---

getFreeTextQueryBuilder_

▸ getFreeTextQueryBuilder_(variantRepo, query, q?): SelectQueryBuilder<ProductVariant>

Parameters

Name	Type	Description
variantRepo	ProductVariantRepository
query	FindWithRelationsOptions
q?	string

Returns

SelectQueryBuilder<ProductVariant>

Defined in

services/product-variant.ts:788

---

getRegionPrice

▸ getRegionPrice(variantId, context): Promise<number>

Parameters

Name	Type	Description
variantId	string
context	GetRegionPriceContext

Returns

Promise<number>

Defined in

services/product-variant.ts:404

---

list

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

Parameters

Name	Type	Description
selector	FilterableProductVariantProps
config	FindConfig<ProductVariant> & PriceSelectionContext

Returns

Promise<ProductVariant[]>

Defined in

services/product-variant.ts:624

---

listAndCount

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

Parameters

Name	Type	Description
selector	FilterableProductVariantProps
config	FindConfig<ProductVariant> & PriceSelectionContext

Returns

Promise<[ProductVariant[], number]>

Defined in

services/product-variant.ts:583

---

prepareListQuery_

▸ prepareListQuery_(selector, config): Object

Parameters

Name	Type	Description
selector	FilterableProductVariantProps
config	FindConfig<ProductVariant>

Returns

Object

Name	Type
q?	string
query	FindWithRelationsOptions
relations	string[]

Defined in

services/product-variant.ts:749

---

retrieve

▸ retrieve(variantId, config?): Promise<ProductVariant>

Parameters

Name	Type	Description
variantId	string
config	FindConfig<ProductVariant> & PriceSelectionContext

Returns

Promise<ProductVariant>

Defined in

services/product-variant.ts:117

---

retrieveBySKU

▸ retrieveBySKU(sku, config?): Promise<ProductVariant>

Parameters

Name	Type	Description
sku	string
config	FindConfig<ProductVariant> & PriceSelectionContext

Returns

Promise<ProductVariant>

Defined in

services/product-variant.ts:147

---

setCurrencyPrice

▸ setCurrencyPrice(variantId, price): Promise<MoneyAmount>

Parameters

Name	Type	Description
variantId	string
price	ProductVariantPrice

Returns

Promise<MoneyAmount>

Defined in

services/product-variant.ts:470

---

setMetadata_

▸ setMetadata_(variant, metadata): Record<string, unknown>

Parameters

Name	Type	Description
variant	ProductVariant
metadata	object

Returns

Record<string, unknown>

Defined in

services/product-variant.ts:717

---

setRegionPrice

▸ setRegionPrice(variantId, price): Promise<MoneyAmount>

Parameters

Name	Type	Description
variantId	string
price	ProductVariantPrice

Returns

Promise<MoneyAmount>

Defined in

services/product-variant.ts:433

---

update

▸ update(variantOrVariantId, update): Promise<ProductVariant>

Parameters

Name	Type	Description
variantOrVariantId	string | Partial<ProductVariant>
update	UpdateProductVariantInput

Returns

Promise<ProductVariant>

Defined in

services/product-variant.ts:288

---

updateOptionValue

▸ updateOptionValue(variantId, optionId, optionValue): Promise<ProductOptionValue>

Parameters

Name	Type	Description
variantId	string
optionId	string
optionValue	string

Returns

Promise<ProductOptionValue>

Defined in

services/product-variant.ts:491

---

updateVariantPrices

▸ updateVariantPrices(variantId, prices): Promise<void>

Parameters

Name	Type	Description
variantId	string
prices	ProductVariantPrice[]

Returns

Promise<void>

Defined in

services/product-variant.ts:366

---

withTransaction

▸ withTransaction(transactionManager): ProductVariantService

Parameters

Name	Type
transactionManager	EntityManager

Returns

ProductVariantService

Defined in

services/product-variant.ts:89