upsertProducts - Product Module Reference

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

upsertProducts(data, sharedContext?): Promise<ProductDTO[]>#

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

Code
1const products = await productModuleService.upsertProducts([2  {3    id: "prod_123",4    handle: "pant",5  },6  {7    title: "Shirt",8  },9])

The attributes to update or create for each product.

sharedContextContextOptional

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

PromisePromise<ProductDTO[]>

The updated and created products.

This method updates the product if it exists, or creates a new ones if it doesn't.

Code
1const product = await productModuleService.upsertProducts({2  title: "Shirt",3})

The attributes to update or create for the new product.

sharedContextContextOptional

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

PromisePromise<ProductDTO>

The updated or created product.