removeProductsFromCollection( )

Developer Preview

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

Deletes products from a specified collection.

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 removeProductsFromCollection(
  _id: string,
  productIds: Array<string>,
): Promise<void>;
Method Parameters
_idstringRequired

ID of the collection from which to remove products.

productIdsArray<string>Required

IDs of the products to remove from the collection.

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

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

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

Did this help?