getOrCreateRibbon( )

Developer Preview

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

Retrieves a ribbon by name, or creates a ribbon if one with the passed ribbonName doesn't exist.

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
Method Parameters
ribbonNamestringRequired

Ribbon name to retrieve or create.

optionsGetOrCreateRibbonOptions
Returns
Return Type:Promise<GetOrCreateRibbonResponse>
JavaScript
Errors

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

Did this help?