Removes media items by ID from a product.
The removeProductMedia()
function returns a Promise that resolves when the
media items with the given IDs are removed from a product with a given ID.
You can remove multiple media items from a product at one time by delimiting the list of products
with commas.
If you do not specify any media IDs, all media items are removed from the product.
Removing media items from a product does not delete the media from the site.
function removeProductMedia(
productId: string,
media: Array<Media>,
): Promise<void>;
ID of the product from which to remove media items.
Sources of media items already uploaded to the Wix site. If no media
is specified, all media items are removed from the product.
/*******************************
* Backend code - products.jsw *
*******************************/
import wixStoresBackend from 'wix-stores-backend';
export function removeProductMedia(productId, media) {
return wixStoresBackend.removeProductMedia(productId, media);
}
/*************
* Page code *
*************/
import wixData from 'wix-data';
import { removeProductMedia } from 'backend/products';
// ...
const productName = ...; // get name of product
wixData.query("Stores/Products")
.eq("name", productName)
.find()
.then((results) => {
if (results.items.length > 0) {
const productId = results.items[0]._id;
removeProductMedia(productId) // not passing media will remove all media from product
.then(() => {
// all media items removed from the product
})
.catch((error) => {
// media items not removed from the product
});
}
});
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.