updateProductCollections - Product Module Reference

This documentation provides a reference to the updateProductCollections 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.

updateProductCollections(id, data, sharedContext?): Promise<ProductCollectionDTO>#

This method is used to update a collection.

Example#

Code
1const collection =2  await productModuleService.updateProductCollections("pcol_123", {3    title: "Summer Collection",4  })

Parameters#

idstring

The ID of the collection to be updated.

dataUpdateProductCollectionDTO

The attributes of the collection to be updated

sharedContextContextOptional

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

Returns#

PromisePromise<ProductCollectionDTO>

The updated collection.

updateProductCollections(selector, data, sharedContext?): Promise<ProductCollectionDTO[]>#

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

Example#

Code
1const collections =2  await productModuleService.updateProductCollections(3    {4      id: ["pcol_123", "pcol_321"],5    },6    {7      title: "Summer Collection",8    }9  )

Parameters#

selectorFilterableProductCollectionProps

The filters specifying which collections to update.

dataUpdateProductCollectionDTO

The attributes to be updated on the selected collections

sharedContextContextOptional

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

Returns#

PromisePromise<ProductCollectionDTO[]>

The updated collections.

Was this page helpful?