updateProductVariants - Product Module Reference

This documentation provides a reference to the updateProductVariants method. This belongs to the Product Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

updateProductVariants(id, data, sharedContext?): Promise<ProductVariantDTO>#

This method is used to update a variant.

Example#

Code
1const variant = await productModuleService.updateProductVariants(2  "variant_123",3  {4    title: "Blue Shirt",5  }6)

Parameters#

idstring

The ID of the variant to be updated.

dataUpdateProductVariantDTO

The attributes of the variant to be updated

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<ProductVariantDTO>

The updated variant.

updateProductVariants(selector, data, sharedContext?): Promise<ProductVariantDTO[]>#

This method is used to update a list of variants matching the specified filters.

Example#

Code
1const variants = await productModuleService.updateProductVariants(2  {3    id: ["variant_123", "variant_321"],4  },5  {6    title: "Blue Shirt",7  }8)

Parameters#

selectorFilterableProductVariantProps

The filters specifying which variants to update.

dataUpdateProductVariantDTO

The attributes to be updated on the selected variants

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<ProductVariantDTO[]>

The updated variants.