removeProductMediaFromChoices( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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).)

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Learn more about app permissions.
Method Declaration
Copy
function removeProductMediaFromChoices(
  _id: string,
  media: Array<MediaAssignmentToChoice>,
): Promise<void>;
Method Parameters
_idstringRequired

Product ID from whose choices to remove media items.

mediaArray<MediaAssignmentToChoice>Required

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

JavaScript
import { products } from "@wix/stores";

async function removeProductMediaFromChoices(id, media) {
  const response = await products.removeProductMediaFromChoices(id, media);
}
Errors

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

Did this help?