bulkUpdateRibbons( )

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 multiple ribbons.

Each time a ribbon is updated, revision increments by 1. The current revision must be passed when updating a ribbon. This ensures you're working with the latest ribbon and prevents unintended overwrites.

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
Manage v3 catalog
Product write in v3 catalog
Ribbon write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
function bulkUpdateRibbons(
  ribbons: Array<MaskedRibbon>,
  options: BulkUpdateRibbonsOptions,
): Promise<BulkUpdateRibbonsResponse>;
Method Parameters
ribbonsArray<MaskedRibbon>Required

List of ribbons to update.

optionsBulkUpdateRibbonsOptions
Returns
Return Type:Promise<BulkUpdateRibbonsResponse>
JavaScript
import { ribbonsV3 } from "@wix/stores";

async function bulkUpdateRibbons(ribbons, options) {
  const response = await ribbonsV3.bulkUpdateRibbons(ribbons, options);
}
Errors

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

Did this help?