upsertProductCollections - Product Module Reference

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

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

This method updates existing collections, or creates new ones if they don't exist.

Example#

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

Parameters#

dataUpsertProductCollectionDTO[]

The attributes to update or create for each collection.

sharedContextContextOptional

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

Returns#

PromisePromise<ProductCollectionDTO[]>

The updated and created collections.

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

This method updates an existing collection, or creates a new one if it doesn't exist.

Example#

Code
1const collection =2  await productModuleService.upsertProductCollections({3    id: "pcol_123",4    title: "Winter Collection",5  })

Parameters#

dataUpsertProductCollectionDTO

The attributes to update or create for the collection.

sharedContextContextOptional

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

Returns#

PromisePromise<ProductCollectionDTO>

The updated or created collection.

Was this page helpful?