> 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

# GetRibbon

# Package: catalogV3

# Namespace: RibbonService

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

## Permission Scopes:
Read ribbons in v3 catalog: SCOPE.STORES.RIBBON_READ

## Introduction

Retrieves a ribbon.

---

## REST API

### Schema

```
 Method: getRibbon
 Description: Retrieves a ribbon.
 URL: https://www.wixapis.com/stores/v3/ribbons/{ribbonId}
 Method: GET
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  ribbonId
 Method parameters: 
   query param name: fields | type: array<fields> | description: Fields to include in the response.  Supported values: `ASSIGNED_PRODUCTS_COUNT` 
                 - enum: ASSIGNED_PRODUCT_COUNT
   param name: ribbonId | type:   none | required: true
 Return type: GetRibbonResponse
  - name: ribbon | type: Ribbon | description: 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

### Get a ribbon with assignedProductCount
Get ribbon with additional requested field assignedProductCount

```curl
curl -X GET \
 'https://www.wixapis.com/stores/v3/ribbons/395153b7-430f-49a9-be4b-6e7eef1e020e?fields=ASSIGNED_PRODUCT_COUNT' \
 -H 'Content-type: application/json' \
 -H 'Authorization: <AUTH>'
```

### Get a ribbon
```curl
curl -X GET \
 'https://www.wixapis.com/stores/v3/ribbons/2254c3b3-6bbd-457d-b868-9122657c5d1c' \
 -H 'Content-type: application/json' \
 -H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.catalogV3.RibbonService.getRibbon(ribbonId, options)
 Description: Retrieves a ribbon.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  ribbonId
 Method parameters: 
   param name: options | type: GetRibbonOptions  none 
        - name: fields | type: array<RequestedFields> | description: Fields to include in the response.  Supported values: `ASSIGNED_PRODUCTS_COUNT` 
             - enum: ASSIGNED_PRODUCT_COUNT
   param name: ribbonId | type: string | description: Ribbon GUID. | 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

### getRibbon
```javascript
import { ribbonsV3 } from '@wix/stores';

async function getRibbon(ribbonId,options) {
  const response = await ribbonsV3.getRibbon(ribbonId,options);
};
```

### getRibbon (with elevated permissions)
```javascript
import { ribbonsV3 } from '@wix/stores';
import { auth } from '@wix/essentials';

async function myGetRibbonMethod(ribbonId,options) {
  const elevatedGetRibbon = auth.elevate(ribbonsV3.getRibbon);
  const response = await elevatedGetRibbon(ribbonId,options);
}
```

### getRibbon (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 getRibbon(ribbonId,options) {
  const response = await myWixClient.ribbonsV3.getRibbon(ribbonId,options);
};
```

---