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 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:
It’s important to note the following points before starting to code:
getCatalogVersion()
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.