> 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

# BulkGetOrCreateRibbons

# Package: catalogV3

# Namespace: RibbonService

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

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

## Introduction

Retrieves multiple ribbons by name, or creates multiple ribbons if those with the passed `ribbonNames` don't exist.

---

## REST API

### Schema

```
 Method: bulkGetOrCreateRibbons
 Description: Retrieves multiple ribbons by name, or creates multiple ribbons if those with the passed `ribbonNames` don't exist.
 URL: https://www.wixapis.com/stores/v3/bulk/ribbons/get-or-create
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  ribbonNames
 Method parameters: 
   param name: fields | type: array<fields> | description: Fields to include in the response.  Supported values: `ASSIGNED_PRODUCTS_COUNT` 
                 - enum: ASSIGNED_PRODUCT_COUNT
   param name: ribbonNames | type: array<ribbonNames> | description: Ribbon names to retrieve or create. | required: true
 Return type: BulkGetOrCreateRibbonsResponse
  - name: results | type: array<BulkRibbonResult> | description: Ribbons retrieved or created by bulk action. 
     - name: itemMetadata | type: ItemMetadata | description: Bulk action metadata for ribbon. 
        - name: id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). 
        - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. 
        - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. 
        - name: error | type: ApplicationError | description: Details about the error in case of failure. 
           - name: code | type: string | description: Error code. 
           - name: description | type: string | description: Description of the error. 
           - name: data | type: object | description: Data related to the error. 
     - name: item | type: Ribbon | description: Full ribbon entity.  Returned only if `returnEntity: true` is passed in the request. 
        - 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. 
  - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata. 
     - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. 
     - name: totalFailures | type: integer | description: Number of items that couldn't be processed. 
     - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. 


```

### Examples

### Bulk get or create ribbons
Bulk fetches the ribbons by names, or creates them if they do not exist.

```curl
curl -X POST \
 'https://www.wixapis.com/stores/v3/bulk/ribbons/get-or-create' \
 -H 'Content-type: application/json' \
 -H 'Authorization: <AUTH>' \
 -d '{
    "ribbonNames": [
        "New Offer!",
        "New collection"
    ]
 }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.catalogV3.RibbonService.bulkGetOrCreateRibbons(ribbonNames, options)
 Description: Retrieves multiple ribbons by name, or creates multiple ribbons if those with the passed `ribbonNames` don't exist.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  ribbonNames
 Method parameters: 
   param name: options | type: BulkGetOrCreateRibbonsOptions  none 
        - name: fields | type: array<RequestedFields> | description: Fields to include in the response.  Supported values: `ASSIGNED_PRODUCTS_COUNT` 
             - enum: ASSIGNED_PRODUCT_COUNT
   param name: ribbonNames | type: array<array> | description: Ribbon names to retrieve or create. | required: true
 Return type: PROMISE<BulkGetOrCreateRibbonsResponse>
  - name: results | type: array<BulkRibbonResult> | description: Ribbons retrieved or created by bulk action. 
     - name: itemMetadata | type: ItemMetadata | description: Bulk action metadata for ribbon. 
        - name: _id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item). 
        - name: originalIndex | type: integer | description: Index of the item within the request array. Allows for correlation between request and response items. 
        - name: success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated. 
        - name: error | type: ApplicationError | description: Details about the error in case of failure. 
           - name: code | type: string | description: Error code. 
           - name: description | type: string | description: Description of the error. 
           - name: data | type: object | description: Data related to the error. 
     - name: item | type: Ribbon | description: Full ribbon entity.  Returned only if `returnEntity: true` is passed in the request. 
        - 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. 
  - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata. 
     - name: totalSuccesses | type: integer | description: Number of items that were successfully processed. 
     - name: totalFailures | type: integer | description: Number of items that couldn't be processed. 
     - name: undetailedFailures | type: integer | description: Number of failures without details because detailed failure threshold was exceeded. 


```

### Examples

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

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

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

async function myBulkGetOrCreateRibbonsMethod(ribbonNames,options) {
  const elevatedBulkGetOrCreateRibbons = auth.elevate(ribbonsV3.bulkGetOrCreateRibbons);
  const response = await elevatedBulkGetOrCreateRibbons(ribbonNames,options);
}
```

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

---