Skip to main content

Class: ProductVariantService

Provides layer to manipulate product variants.

Hierarchy

  • "medusa-interfaces"

    ProductVariantService

Constructors

constructor

new ProductVariantService(__namedParameters)

Parameters

NameType
__namedParametersObject

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

NameType
CREATEDstring
DELETEDstring
UPDATEDstring

Defined in

services/product-variant.ts:36

Methods

addOptionValue

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

Adds option value to a varaint. Fails when product with variant does not exists or if that product does not have an option with the given option id. Fails if given variant is not found. Option value must be of type string or number.

Parameters

NameTypeDescription
variantIdstringthe variant to decorate.
optionIdstringthe option from product.
optionValuestringoption value to add.

Returns

Promise<ProductOptionValue>

the result of the update operation.

Defined in

services/product-variant.ts:553


create

create(productOrProductId, variant): Promise<ProductVariant>

Creates an unpublished product variant. Will validate against parent product to ensure that the variant can in fact be created.

Parameters

NameTypeDescription
productOrProductIdstring | Productthe product the variant will be added to
variantCreateProductVariantInputthe variant to create

Returns

Promise<ProductVariant>

resolves to the creation result.

Defined in

services/product-variant.ts:207


delete

delete(variantId): Promise<void>

Deletes variant. Will never fail due to delete being idempotent.

Parameters

NameTypeDescription
variantIdstringthe id of the variant to delete. Must be castable as an ObjectId

Returns

Promise<void>

empty promise

Defined in

services/product-variant.ts:746


deleteOptionValue

deleteOptionValue(variantId, optionId): Promise<void>

Deletes option value from given variant. Will never fail due to delete being idempotent.

Parameters

NameTypeDescription
variantIdstringthe variant to decorate.
optionIdstringthe option from product.

Returns

Promise<void>

empty promise

Defined in

services/product-variant.ts:580


getFreeTextQueryBuilder_

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

Lists variants based on the provided parameters and includes the count of variants that match the query.

Parameters

NameTypeDescription
variantRepoProductVariantRepositorythe variant repository
queryFindWithRelationsOptionsobject that defines the scope for what should be returned
q?stringfree text query

Returns

SelectQueryBuilder<ProductVariant>

an array containing the products as the first element and the total count of products that matches the query as the second element.

Defined in

services/product-variant.ts:852


getRegionPrice

getRegionPrice(variantId, context): Promise<number>

Gets the price specific to a region. If no region specific money amount exists the function will try to use a currency price. If no default currency price exists the function will throw an error.

Parameters

NameTypeDescription
variantIdstringthe id of the variant to get price from
contextGetRegionPriceContextcontext for getting region price

Returns

Promise<number>

the price specific to the region

Defined in

services/product-variant.ts:428


list

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

Parameters

NameTypeDescription
selectorFilterableProductVariantPropsthe query object for find
configFindConfig<ProductVariant> & PriceSelectionContextquery config object for variant retrieval

Returns

Promise<ProductVariant[]>

the result of the find operation

Defined in

services/product-variant.ts:677


listAndCount

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

Parameters

NameTypeDescription
selectorFilterableProductVariantPropsthe query object for find
configFindConfig<ProductVariant> & PriceSelectionContextquery config object for variant retrieval

Returns

Promise<[ProductVariant[], number]>

the result of the find operation

Defined in

services/product-variant.ts:607


prepareListQuery_

prepareListQuery_(selector, config): Object

Creates a query object to be used for list queries.

Parameters

NameTypeDescription
selectorFilterableProductVariantPropsthe selector to create the query from
configFindConfig<ProductVariant>the config to use for the query

Returns

Object

an object containing the query, relations and free-text search param.

NameType
q?string
queryFindWithRelationsOptions
relationsstring[]

Defined in

services/product-variant.ts:813


retrieve

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

Gets a product variant by id.

Parameters

NameTypeDescription
variantIdstringthe id of the product to get.
configFindConfig<ProductVariant> & PriceSelectionContextquery config object for variant retrieval.

Returns

Promise<ProductVariant>

the product document.

Defined in

services/product-variant.ts:117


retrieveBySKU

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

Gets a product variant by id.

Parameters

NameTypeDescription
skustringThe unique stock keeping unit used to identify the product variant.
configFindConfig<ProductVariant> & PriceSelectionContextquery config object for variant retrieval.

Returns

Promise<ProductVariant>

the product document.

Defined in

services/product-variant.ts:162


setAdditionalPrices

setAdditionalPrices(variant, currency_code, region_id, cart_id, customer_id, include_discount_prices?): Promise<ProductVariant | ProductVariant[]>

Set additional prices on a list of variants.

Parameters

NameTypeDefault valueDescription
variantanyundefinedvariant on which to set additional prices
currency_codeanyundefinedcurrency code to fetch prices for
region_idanyundefinedregion to fetch prices for
cart_idanyundefinedstring of cart to use as a basis for getting currency and region
customer_idanyundefinedid of potentially logged in customer, used to get prices valid for their customer groups
include_discount_pricesbooleanfalseshould result include discount pricing

Returns

Promise<ProductVariant | ProductVariant[]>

A list of variants with variants decorated with "additional_prices"

Defined in

services/product-variant.ts:897


setCurrencyPrice

setCurrencyPrice(variantId, price): Promise<MoneyAmount>

Sets the default price for the given currency.

Parameters

NameTypeDescription
variantIdstringthe id of the variant to set prices for
priceProductVariantPricethe price for the variant

Returns

Promise<MoneyAmount>

the result of the update operation

Defined in

services/product-variant.ts:494


setMetadata_

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

Dedicated method to set metadata for a variant.

Parameters

NameTypeDescription
variantProductVariantthe variant to set metadata for.
metadataobjectthe metadata to set

Returns

Record<string, unknown>

updated metadata object

Defined in

services/product-variant.ts:781


setRegionPrice

setRegionPrice(variantId, price): Promise<MoneyAmount>

Sets the default price of a specific region

Parameters

NameTypeDescription
variantIdstringthe id of the variant to update
priceProductVariantPricethe price for the variant.

Returns

Promise<MoneyAmount>

the result of the update operation

Defined in

services/product-variant.ts:457


update

update(variantOrVariantId, update): Promise<ProductVariant>

Updates a variant. Price updates should use dedicated methods. The function will throw, if price updates are attempted.

Parameters

NameTypeDescription
variantOrVariantIdstring | Partial<ProductVariant>variant or id of a variant.
updateUpdateProductVariantInputan object with the update values.

Returns

Promise<ProductVariant>

resolves to the update result.

Defined in

services/product-variant.ts:312


updateOptionValue

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

Updates variant's option value. Option value must be of type string or number.

Parameters

NameTypeDescription
variantIdstringthe variant to decorate.
optionIdstringthe option from product.
optionValuestringoption value to add.

Returns

Promise<ProductOptionValue>

the result of the update operation.

Defined in

services/product-variant.ts:515


updateVariantPrices

updateVariantPrices(variantId, prices): Promise<void>

Updates a variant's prices. Deletes any prices that are not in the update object, and is not associated with a price list.

Parameters

NameTypeDescription
variantIdstringthe id of variant variant
pricesProductVariantPrice[]the update prices

Returns

Promise<void>

empty promise

Defined in

services/product-variant.ts:390


withTransaction

withTransaction(transactionManager): ProductVariantService

Parameters

NameType
transactionManagerEntityManager

Returns

ProductVariantService

Defined in

services/product-variant.ts:89