About the Ribbons API

The Ribbons API allows you to create and manage ribbons, which can then be assigned to products using the Products API.

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 enhances product visibility and sales.

With the Ribbons API, you can:

• Create and manage a bank of reusable ribbons.
• Retrieve information about existing ribbons.
• Query ribbons with filtering and sorting.
• Get or create ribbons by name.

Assigning ribbons to products

You can assign a ribbon to a product by:

• Passing the ribbon's id when creating or updating a product.
• Passing a ribbon name. If a ribbon with that name exists, it will be assigned; otherwise, a new ribbon will be created.

Deleting ribbons

When a ribbon is deleted, it is automatically removed from all products that reference it.

Before you begin

It's important to note the following point before starting to code:

• The site owner must install the Wix Stores app from the Wix App Market.

Use cases

• Create a product with a new ribbon
• Assign an existing ribbon to a product