> 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

# QueryRibbons

# Package: catalogV3

# Namespace: RibbonService

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

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

## Introduction

Retrieves a list of up to 100 ribbons, given the provided filtering, sorting, and cursor paging.
Pass supported values to the `fields` array in the request to include those fields in the response.


Query Brands runs with these defaults, which you can override:

- `createdDate` is sorted in `DESC` order
- `cursorPaging.limit` is `100`

To learn about working with _Query_ endpoints, see
[API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md),
and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging.md).

---

## REST API

### Schema

```
 Method: queryRibbons
 Description: Retrieves a list of up to 100 ribbons, given the provided filtering, sorting, and cursor paging. Pass supported values to the `fields` array in the request to include those fields in the response.   Query Brands runs with these defaults, which you can override:  - `createdDate` is sorted in `DESC` order - `cursorPaging.limit` is `100`  To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md), and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging.md).
 URL: https://www.wixapis.com/stores/v3/ribbons/query
 Method: POST
 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: query | type: CursorQuery   
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. 
        - name: limit | type: integer | description: Maximum number of items to return in the results. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. 
        - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` 
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` 
           - name: fieldName | type: string | description: Name of the field to sort by. 
           - name: order | type: SortOrder | description: Sort order. 
                 - enum:
                 -     ASC: Ascending order.
                 -     DESC: Descending order.
 Return type: QueryRibbonsResponse
  - name: ribbons | type: array<Ribbon> | description: List of ribbons. 
     - 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: pagingMetadata | type: CursorPagingMetadata | description: Details on the paged set of results returned. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. 
        - name: next | type: string | description: Cursor string pointing to the next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. 
     - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page.  + `true`: Another page of results can be retrieved. + `false`: This is the last page. 


```

### Examples

### Query ribbons with cursor paging
This is the followup query to the query ribbons example. It demonstrates how to use cursor paging to retrieve the next page of ribbons.

```curl
curl -X POST \
 'https://www.wixapis.com/stores/v3/ribbons/query' \
 -H 'Content-type: application/json' \
 -H 'Authorization: <AUTH>' \
 -d '{
   "query": {
     "cursorPaging": {
        "cursor": "d8c06edfa2eef21fd087e1f5b2ed0daa259694e7.EiQqIgogCgRuYW1lEhgqFgoUCgskc3RhcnRzV2l0aBIFGgNOZXcaLQoMX2NyZWF0ZWREYXRlEAEaGyoZChcKCiR0aW1lc3RhbXASCREAYJzLOwV5QiIkZjQ4MGY3NmQtZjJkOS00NzliLTg5NzgtNjQ4NmYwNmY0NzJk"
     }
   }
 }'
```

### Query ribbons
```curl
curl -X POST \
 'https://www.wixapis.com/stores/v3/ribbons/query' \
 -H 'Content-type: application/json' \
 -H 'Authorization: <AUTH>' \
 -d '{
   "query": {
     "filter": {"name": {"$startsWith":"New"}},
     "sort": [{"fieldName":"createdDate","order":"DESC"}],
     "cursorPaging": {"limit": 2}
    }
 }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.catalogV3.RibbonService.queryRibbons(query, options)
 Description: Retrieves a list of up to 100 ribbons, given the provided filtering, sorting, and cursor paging. Pass supported values to the `fields` array in the request to include those fields in the response.   Query Brands runs with these defaults, which you can override:  - `createdDate` is sorted in `DESC` order - `cursorPaging.limit` is `100`  To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md), and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging.md).
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  query
 Method parameters: 
   param name: options | type: QueryRibbonsOptions  none 
        - name: fields | type: array<RequestedFields> | description: Fields to include in the response.  Supported values: `ASSIGNED_PRODUCTS_COUNT` 
             - enum: ASSIGNED_PRODUCT_COUNT
   param name: query | type: RibbonQuery   | required: true
     - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. 
        - name: limit | type: integer | description: Maximum number of items to return in the results. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. 
        - name: filter | type: object | description: Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }` Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` 
        - name: sort | type: array<Sorting> | description: Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` 
           - name: fieldName | type: string | description: Name of the field to sort by. 
           - name: order | type: SortOrder | description: Sort order. 
                 - enum:
                 -     ASC: Ascending order.
                 -     DESC: Descending order.
 Return type: PROMISE<QueryRibbonsResponse>
  - name: ribbons | type: array<Ribbon> | description: List of ribbons. 
     - 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: pagingMetadata | type: CursorPagingMetadata | description: Details on the paged set of results returned. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. 
        - name: next | type: string | description: Cursor string pointing to the next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. 
     - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page.  + `true`: Another page of results can be retrieved. + `false`: This is the last page. 


```

### Examples

### Query ribbons with cursor paging
```javascript
import { ribbonsV3 } from "@wix/stores";

const options = {
  query: {
    cursorPaging: {
      cursor: "d8c06edfa2eef21fd087e1f5b2ed0daa259694e7.EiQqIgogCgRuYW1lEhgqFgoUCgskc3RhcnRzV2l0aBIFGgNOZXcaLQoMX2NyZWF0ZWREYXRlEAEaGyoZChcKCiR0aW1lc3RhbXASCREAYJzLOwV5QiIkZjQ4MGY3NmQtZjJkOS00NzliLTg5NzgtNjQ4NmYwNmY0NzJk"
    }
  }
};

async function queryRibbons() {
  const response = await ribbonsV3.queryRibbons(options);
}

/* Promise resolves to:
 * {
 *   "ribbons": [
 *     { "_id": "f480f76d-...", "revision": "1", "name": "New Season" }
 *   ],
 *   "pagingMetadata": { "count": 1, "cursors": {}, "hasNext": false }
 * }
 */


```

### Query ribbons
Query ribbons filtered by name prefix and sorted by creation date

```javascript
import { ribbonsV3 } from "@wix/stores";

const options = {
  query: {
    filter: {
      name: {
        $startsWith: "New"
      }
    },
    sort: [
      {
        fieldName: "createdDate",
        order: "DESC"
      }
    ],
    cursorPaging: {
      limit: 2
    }
  }
};

async function queryRibbons() {
  const response = await ribbonsV3.queryRibbons(options);
}

/* Promise resolves to:
 * {
 *   "ribbons": [
 *     { "_id": "8e6b7884-...", "revision": "1", "name": "New Offer!" },
 *     { "_id": "0bc5a458-...", "revision": "1", "name": "New Arrival" }
 *   ],
 *   "pagingMetadata": {
 *     "count": 2,
 *     "cursors": { "next": "d8c06edf..." },
 *     "hasNext": true
 *   }
 * }
 */


```

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

---