> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# CreateRibbon

# Package: catalogV3

# Namespace: RibbonService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/ribbons-v3/create-ribbon.md

## Permission Scopes:
Ribbon write in v3 catalog: SCOPE.STORES.RIBBON_WRITE

## Introduction

Creates a ribbon.

To assign the ribbon to a product, include the `ribbon.id` or `ribbon.name` when [creating](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/create-product.md) or [updating](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/update-product.md) a product.

---

## REST API

### Schema

```
 Method: createRibbon
 Description: Creates a ribbon.  To assign the ribbon to a product, include the `ribbon.id` or `ribbon.name` when [creating](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/create-product.md) or [updating](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/update-product.md) a product.
 URL: https://www.wixapis.com/stores/v3/ribbons
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  ribbon, ribbon.name
 Method parameters: 
   param name: ribbon | type: Ribbon | description: A Ribbon is a visual element that you can assign to products to highlight them on your site. | required: true
        - name: name | type: string | description: Ribbon name. | required: true
 Return type: CreateRibbonResponse
  - name: ribbon | type: Ribbon | description: Created ribbon. 
     - name: id | type: string | description: Ribbon GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the ribbon is updated. To prevent conflicting changes, the current revision must be passed when updating the ribbon.  Ignored when creating a ribbon. 
     - name: createdDate | type: string | description: Date and time the ribbon was created. 
     - name: updatedDate | type: string | description: Date and time the ribbon was updated. 
     - name: name | type: string | description: Ribbon name. 
     - name: assignedProductCount | type: integer | description: Number of products this ribbon is assigned to. Includes both primary and additional ribbons.  > **Note:** Returned only when you pass `"ASSIGNED_PRODUCT_COUNT"` to the `fields` array in Ribbon API requests. 


```

### Examples

### Create a ribbon
```curl
curl -X POST \
 'https://www.wixapis.com/stores/v3/ribbons' \
 -H 'Content-type: application/json' \
 -H 'Authorization: <AUTH>' \
 -d '{
   "ribbon": {
     "name": "New Offer!"
   }
 }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.catalogV3.RibbonService.createRibbon(ribbon)
 Description: Creates a ribbon.  To assign the ribbon to a product, include the `ribbon.id` or `ribbon.name` when [creating](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/create-product.md) or [updating](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/products-v3/update-product.md) a product.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  ribbon, ribbon.name
 Method parameters: 
   param name: ribbon | type: Ribbon | description: A Ribbon is a visual element that you can assign to products to highlight them on your site. | required: true
        - name: name | type: string | description: Ribbon name. | required: true
 Return type: PROMISE<Ribbon>
  - name: _id | type: string | description: Ribbon GUID. 
  - name: revision | type: string | description: Revision number, which increments by 1 each time the ribbon is updated. To prevent conflicting changes, the current revision must be passed when updating the ribbon.  Ignored when creating a ribbon. 
  - name: _createdDate | type: Date | description: Date and time the ribbon was created. 
  - name: _updatedDate | type: Date | description: Date and time the ribbon was updated. 
  - name: name | type: string | description: Ribbon name. 
  - name: assignedProductCount | type: integer | description: Number of products this ribbon is assigned to. Includes both primary and additional ribbons.  > **Note:** Returned only when you pass `"ASSIGNED_PRODUCT_COUNT"` to the `fields` array in Ribbon API requests. 


```

### Examples

### Create a ribbon
```javascript
import { ribbonsV3 } from "@wix/stores";

const ribbon = {
  name: "New Offer!"
};

async function createRibbon() {
  const response = await ribbonsV3.createRibbon(ribbon);
}


```

### createRibbon (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { ribbonsV3 } from '@wix/stores';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { ribbonsV3 },
  // Include the auth strategy and host as relevant
});


async function createRibbon(ribbon) {
  const response = await myWixClient.ribbonsV3.createRibbon(ribbon);
};
```

---