Ribbons: Sample Use Cases and Flows

This article shares a possible use case your app could support, as well as sample flows that could support this use case. This can be a helpful jumping-off point as you plan your app's implementation.

Create a product with a new ribbon

To create a product and assign a new ribbon with a single API call: Call Create Product and pass a new product.ribbon.name to the product.ribbon field.

Note: if you pass the ribbon.name of a ribbon you've already created, that ribbon will be assigned to the product.

Assign an existing ribbon to a product

The Ribbons API allows you to create, update, and manage multiple ribbons. You can then use and reuse these ribbons and assign them across multiple products.

To create and assign a ribbon to a product:

1. Call Create Ribbon.
2. Save the ribbon.id or ribbon.name from your newly created ribbon.
3. Call Create Product or Update Product, and pass either the ribbon.id or the ribbon.name to the product.ribbon field.