removeProductMediaFromChoices( )

Removes media items from all or some of a product's choices. (Media items can only be set for choices within one option at a time - e.g., if you set media items for some or all of the choices within the Colors option (blue, green, and red), you won't be able to also assign media items to choices within the Size option (S, M, and L).)

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function removeProductMediaFromChoices(_id: string, media: Array<MediaAssignmentToChoice>): Promise<void>

removeProductMediaFromChoices Parameters

NAME

TYPE

DESCRIPTION

_id

string

Product ID from whose choices to remove media items.

media

Array<

MediaAssignmentToChoice

Media to remove from choices. If an empty array is passed, all media will be removed from all choices for the given product.

Returns

Return Type:

Promise<

void

Was this helpful?

removeProductMediaFromChoices example

Copy Code

1import { products } from 'wix-stores.v2';
2  
3 async function removeProductMediaFromChoices(id, media) {
4   try {
5     const result = await products.removeProductMediaFromChoices(id, media);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13