# About the Wix Stores Ribbons V3 API

The Ribbons API allows you to create and manage ribbons,
which can then be assigned to products using the [Products API](fallback::https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/products-v3/introduction).

Ribbons enhance product visibility and customer engagement by highlighting specific product features or promotions.
Use ribbons to draw attention to key product information such as new arrivals, bestsellers, limited stock, or any custom label that you feel will enhance product visibility and sales.

This API provides all the necessary functionality to manage a bank of ribbons,
which can be applied to products to ensure a consistent ribbon experience across your store.

With the Ribbons API, you can:
* Create and manage a bank of ribbons.
* Retrieve information about existing ribbons.

## Before you begin
It’s important to note the following points before starting to code:
* The Ribbons V3 API is only available for use with the Stores Catalog V3.
* You must call [`getCatalogVersion()`](fallback::https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-versioning/get-catalog-version) to get the site's Stores catalog version before using any of the Ribbons V3 API methods. If the site uses Stores Catalog V1, the Ribbons V3 API methods will not be available.

@package_metadata:@wix/stores

To use the RibbonsV3 API, install the `@wix/stores` package.

#### Install the package

Follow the installation instructions for your development environment.

| Development environment | Installation method |
|--|--|
| Wix sites (editor or IDE) | Use the [package manager](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-in-the-editor). |
| Wix sites (local IDE) | Run `wix install @wix/stores` using the [Wix CLI](fallback::https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/packages/work-with-npm-packages-with-the-wix-cli).|
| Blocks apps | Use the same installation method as Wix sites. |
| CLI and self-hosted apps | Run `npm install @wix/stores` or `yarn add @wix/stores`. |
| Headless sites and apps | Run `npm install @wix/stores` or `yarn add @wix/stores`. |

#### Import the package

To import the package in your code:

```js
import { ribbonsV3 } from '@wix/stores'
```

Coding Examples

Sled Tests

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

Picasso

GraphQL (Alpha)

onRibbonDeleted( )