> 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

# ListItems

# Package: items

# Namespace: RestaurantsMenusItem

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

## Permission Scopes:
Manage Restaurants - all permissions: SCOPE.RESTAURANTS.MEGA-SCOPES

## Introduction

> **Note:** The Item 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 up to 500 items.

---

## REST API

### Schema

```
 Method: listItems
 Description: > **Note:** The Item 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 up to 500 items.
 URL: https://www.wixapis.com/restaurants/menus/v1/items
 Method: GET
 Method parameters:
   query param name: itemIds | type: array<itemIds> | description: Item GUIDs. 
   query param name: onlyVisible | type: onlyVisible | description: Whether to return only items that are visible to site visitors. 
   param name: paging | type: CursorPaging   
        - 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. 
 Return type: ListItemsResponse
  - name: items | type: array<Item> | description: Items. 
     - ONE-OF: 
        - name: priceVariants | type: PriceVariants | description: Item price variants. 
           - name: variants | type: array<PriceVariant> | description: List of price variants. 
              - name: variantId | type: string | description: Price variant GUID. 
              - name: priceInfo | type: PriceInfo | description: Price info of a variant. 
                 - name: price | type: string | description: Price. 
        - name: priceInfo | type: PriceInfo | description: Item price info. 
     - name: id | type: string | description: Item GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the item is updated. To prevent conflicting changes, the current revision must be passed when updating the item. Ignored when creating a item. 
     - name: createdDate | type: string | description: Date and time the item was created. 
     - name: updatedDate | type: string | description: Date and time the item was updated. 
     - name: name | type: string | description: Item name. 
     - name: description | type: string | description: Item description. 
     - name: image | type: Image | description: Main item image. 
        - 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: additionalImages | type: array<Image> | description: Additional item images. 
     - name: labels | type: array<Label> | description: Item labels. 
        - name: id | type: string | description: Item label GUID. 
     - name: visible | type: boolean | description: Whether the item is visible in the menu for site visitors. 
     - name: featured | type: boolean | description: Whether the item is marked as featured/best seller. Default: `false`. 
     - name: orderSettings | type: OrderSettings | description: Online order settings. 
        - name: inStock | type: boolean | description: Whether the item is in stock. Default: `true`. 
        - name: acceptSpecialRequests | type: boolean | description: Whether a customer can add a special request when ordering this item. Default: `true`. 
     - name: modifierGroups | type: array<ModifierGroup> | description: Item modifier groups. 
        - name: id | type: string | description: Modifier group GUID. 
     - 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: businessLocationIds | type: array | description: IDs of the business locations ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/about-business-locations.md) | [REST](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/about-business-locations.md)) where these items are available. 
  - 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

### List Items
```curl
curl -X GET https://www.wixapis.com/restaurants/menus-item/v1/items \
-H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.items.RestaurantsMenusItem.listItems(options)
 Description: > **Note:** The Item 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 up to 500 items.
 Method parameters:
   param name: options | type: ListItemsOptions  none 
        - name: itemIds | type: array | description: Item GUIDs. 
        - name: paging | type: CursorPaging | description: The metadata of the paginated results. 
           - 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: onlyVisible | type: boolean | description: Whether to return only items that are visible to site visitors. 
 Return type: PROMISE<ListItemsResponse>
  - name: items | type: array<Item> | description: Items. 
     - ONE-OF: 
        - name: priceVariants | type: PriceVariants | description: Item price variants. 
           - name: variants | type: array<PriceVariant> | description: List of price variants. 
              - name: variantId | type: string | description: Price variant GUID. 
              - name: priceInfo | type: PriceInfo | description: Price info of a variant. 
                 - name: price | type: string | description: Price. 
        - name: priceInfo | type: PriceInfo | description: Item price info. 
     - name: _id | type: string | description: Item GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the item is updated. To prevent conflicting changes, the current revision must be passed when updating the item. Ignored when creating a item. 
     - name: _createdDate | type: Date | description: Date and time the item was created. 
     - name: _updatedDate | type: Date | description: Date and time the item was updated. 
     - name: name | type: string | description: Item name. 
     - name: description | type: string | description: Item description. 
     - name: image | type: string | description: Main item image. 
     - name: additionalImages | type: array | description: Additional item images. 
     - name: labels | type: array<Label> | description: Item labels. 
        - name: _id | type: string | description: Item label GUID. 
     - name: visible | type: boolean | description: Whether the item is visible in the menu for site visitors. 
     - name: featured | type: boolean | description: Whether the item is marked as featured/best seller. Default: `false`. 
     - name: orderSettings | type: OrderSettings | description: Online order settings. 
        - name: inStock | type: boolean | description: Whether the item is in stock. Default: `true`. 
        - name: acceptSpecialRequests | type: boolean | description: Whether a customer can add a special request when ordering this item. Default: `true`. 
     - name: modifierGroups | type: array<ModifierGroup> | description: Item modifier groups. 
        - name: _id | type: string | description: Modifier group GUID. 
     - 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: businessLocationIds | type: array | description: IDs of the business locations ([SDK](https://dev.wix.com/docs/sdk/backend-modules/restaurants/wix-restaurants-new/about-business-locations.md) | [REST](https://dev.wix.com/docs/rest/business-solutions/restaurants/wix-restaurants-new/about-business-locations.md)) where these items are available. 
  - 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

### listItems
```javascript
import { items } from '@wix/restaurants';

async function listItems(options) {
  const response = await items.listItems(options);
};
```

### listItems (with elevated permissions)
```javascript
import { items } from '@wix/restaurants';
import { auth } from '@wix/essentials';

async function myListItemsMethod(options) {
  const elevatedListItems = auth.elevate(items.listItems);
  const response = await elevatedListItems(options);
}
```

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

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


async function listItems(options) {
  const response = await myWixClient.items.listItems(options);
};
```

---