getRibbon( )

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.

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
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Read v3 catalog
Manage v3 catalog
Product write in v3 catalog
Read ribbons in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
function getRibbon(
  ribbonId: string,
  options: GetRibbonOptions,
): Promise<Ribbon>;
Method Parameters
ribbonIdstringRequired

Ribbon ID.

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

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

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

Did this help?