> 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

# QueryLabels

# Package: items

# Namespace: RestaurantsMenusItemLabels

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/restaurants/menus/items/item-labels/query-labels.md

## Permission Scopes:
Wix Multilingual - Nile Wrapper Domain Events Read: SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ

## Introduction

> **Note:** The Label API only works with the Wix Restaurants Menus app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).

Retrieves a list of item labels given the provided paging, filtering, and sorting. Up to 500 labels can be returned per request.

To learn how to query labels, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md).

---

## REST API

### Schema

```
 Method: queryLabels
 Description: > **Note:** The Label API only works with the Wix Restaurants Menus app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).  Retrieves a list of item labels given the provided paging, filtering, and sorting. Up to 500 labels can be returned per request.  To learn how to query labels, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md).
 URL: https://www.wixapis.com/restaurants/menus/v1/labels/query
 Method: POST
 Method parameters:
   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: Number of items to load. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  You can get 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, DESC
 Return type: QueryLabelsResponse
  - name: labels | type: array<Label> | description: Retrieved item labels. 
     - name: id | type: string | description: Item label GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the item label is updated. To prevent conflicting changes, the current revision must be passed when updating the item label. Ignored when creating a item label. 
     - name: createdDate | type: string | description: Date and time the item label was created. 
     - name: updatedDate | type: string | description: Date and time the item label was updated. 
     - name: name | type: string | description: Item label name. 
     - name: icon | type: Image | description: Item label icon. 
        - name: id | type: string | description: WixMedia image GUID. 
        - name: url | type: string | description: Image URL. 
        - name: height | type: integer | description: Original image height. 
        - name: width | type: integer | description: Original image width. 
        - name: altText | type: string | description: Image alt text. 
        - name: filename | type: string | description: Image filename. 
     - name: extendedFields | type: ExtendedFields | description: Extended fields. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
  - name: pagingMetadata | type: CursorPagingMetadata | description: The metadata of the paginated results. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Offset that was requested. 
        - name: next | type: string | description: Cursor pointing to next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to previous page in the list of results. 
     - name: hasNext | type: boolean | description: Indicates if there are more results after the current page. If `true`, another page of results can be retrieved. If `false`, this is the last page. 


```

### Examples

### Query labels
```curl
curl -X POST https://www.wixapis.com/restaurants/item-labels/v1/labels/query \
    -H 'Authorization: <AUTH> \
    --data-binary '{
      "query": {
        "sort": [],
        "filter": {
          "icon": {
            "$exists": true
          }
        }
      }
    }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.items.RestaurantsMenusItemLabels.queryLabels(query)
 Description: > **Note:** The Label API only works with the Wix Restaurants Menus app. Make sure you have installed this app from the [Wix App Market](https://www.wix.com/app-market/wix-restaurants-menus-new).  Retrieves a list of item labels given the provided paging, filtering, and sorting. Up to 500 labels can be returned per request.  To learn how to query labels, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.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: query | type: ItemLabelQuery   | 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: Number of items to load. 
        - name: cursor | type: string | description: Pointer to the next or previous page in the list of results.  You can get 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, DESC
 Return type: PROMISE<QueryLabelsResponse>
  - name: labels | type: array<Label> | description: Retrieved item labels. 
     - name: _id | type: string | description: Item label GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the item label is updated. To prevent conflicting changes, the current revision must be passed when updating the item label. Ignored when creating a item label. 
     - name: _createdDate | type: Date | description: Date and time the item label was created. 
     - name: _updatedDate | type: Date | description: Date and time the item label was updated. 
     - name: name | type: string | description: Item label name. 
     - name: icon | type: string | description: Item label icon. 
     - name: extendedFields | type: ExtendedFields | description: Extended fields. 
        - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured.  You can only access fields for which you have the appropriate permissions.  Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). 
  - name: pagingMetadata | type: CursorPagingMetadata | description: The metadata of the paginated results. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: cursors | type: Cursors | description: Offset that was requested. 
        - name: next | type: string | description: Cursor pointing to next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to previous page in the list of results. 
     - name: hasNext | type: boolean | description: Indicates if there are more results after the current page. If `true`, another page of results can be retrieved. If `false`, this is the last page. 


```

### Examples

### Query labels
Query labels that have an icon

```javascript
import { itemLabels } from "@wix/restaurants";

const options = {
  query: {
    filter: {
      icon: {
        $exists: true
      }
    }
  }
};

async function queryLabels() {
  const response = await itemLabels.queryLabels().find();
}

/* Promise resolves to:
 * {
 *   "items": [
 *     {
 *       "_id": "29b369c7-88cb-473b-bd9f-f2c71d177fff",
 *       "revision": "1",
 *       "name": "Fish",
 *       "icon": "wix:image://v1/ec845c_1e78a0f38d104cfb9e375a4d1cb3066b.svg#originWidth=24&originHeight=24"
 *     },
 *     {
 *       "_id": "6046e53c-4ce3-41f7-9e2a-0f7352fe4975",
 *       "revision": "1",
 *       "name": "Vegan",
 *       "icon": "wix:image://v1/ec845c_2306a227a54044a9999b9f5e5fdf2185.svg#originWidth=24&originHeight=24"
 *     }
 *   ],
 *   "pagingMetadata": {
 *     "count": 2,
 *     "hasNext": false
 *   }
 * }
 */

```

### queryLabels (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 { itemLabels } from '@wix/restaurants';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

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


async function queryLabels(query) {
  const response = await myWixClient.itemLabels.queryLabels(query);
};
```

---