addProductMedia( )


Adds media items by ID to a product.

The addProductMedia() function returns a Promise that resolves when the adding of the media (images or videos) to a product has started.

Limitation The URL is not validated and no event is triggered to indicate if the media was added successfully.

Method Declaration
Copy
function addProductMedia(productId: string, media: Array<Media>): Promise<void>;
Method Parameters
productIdstringRequired

Product ID.


mediaArray<Media>Required

Sources of media items already uploaded to the Wix site.

Add media items to a product
JavaScript
/******************************* * Backend code - products.jsw * *******************************/ import wixStoresBackend from 'wix-stores-backend'; export function addProductMedia(productId, mediaData) { return wixStoresBackend.addProductMedia(productId, mediaData); } /************* * Page code * *************/ import { addProductMedia } from 'backend/myModule'; // ... const productId = ...; // get product ID const src = "wix:image://v1/1a11a1_..._1a~mv2.jpg/1a11a1_..._1a~mv2.jpg"; const choice = "Color"; const option = "Blue"; if (choice !== "" && option !== "") { const mediaData = [{ // add media item to a choice src, "choice": { choice, option } }] } else { const mediaData = [{ // add media item to the product src }] } addProductMedia(productId, mediaData)
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?