updateCollection( )

Developer Preview

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

Updates specified properties of a collection. To add products to a collection, call the addProductsToCollection function.

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 updateCollection(
  _id: string,
  collection: UpdateCollection,
): Promise<UpdateCollectionResponse>;
Method Parameters
_idstringRequired

Collection ID (generated automatically by the catalog).

collectionUpdateCollectionRequired

Collection info to update.

Returns
Return Type:Promise<UpdateCollectionResponse>
JavaScript
import { products } from "@wix/stores";

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

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

Did this help?