> 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

# ListVariants

# Package: items

# Namespace: VariantsService

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

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

## Introduction

> **Note:** The Item Variants 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 item variants.

---

## REST API

### Schema

```
 Method: listVariants
 Description: > **Note:** The Item Variants 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 item variants.
 URL: https://www.wixapis.com/restaurants/menus/v1/variants
 Method: GET
 Method parameters:
   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. 
   query param name: variantIds | type: array<variantIds> | description: Item variant GUIDs. 
 Return type: ListVariantsResponse
  - name: variants | type: array<Variant> | description: The retrieved item variants. 
     - name: id | type: string | description: Item variant GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the item variant is updated. To prevent conflicting changes, the current revision must be passed when updating the item variant. Ignored when creating an item variant. 
     - name: createdDate | type: string | description: Date and time the item variant was created. 
     - name: updatedDate | type: string | description: Date and time the item variant was updated. 
     - name: name | type: string | description: Item variant name. 
     - 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 item variants are available. 
  - name: metadata | 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 all variants
```curl
curl -X GET https://www.wixapis.com/restaurants/item-variants/v1/variants \
    -H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.items.VariantsService.listVariants(options)
 Description: > **Note:** The Item Variants 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 item variants.
 Method parameters:
   param name: options | type: ListVariantsOptions  none 
        - name: variantIds | type: array | description: Item variant 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. 
 Return type: PROMISE<ListVariantsResponse>
  - name: variants | type: array<Variant> | description: The retrieved item variants. 
     - name: _id | type: string | description: Item variant GUID. 
     - name: revision | type: string | description: Revision number, which increments by 1 each time the item variant is updated. To prevent conflicting changes, the current revision must be passed when updating the item variant. Ignored when creating an item variant. 
     - name: _createdDate | type: Date | description: Date and time the item variant was created. 
     - name: _updatedDate | type: Date | description: Date and time the item variant was updated. 
     - name: name | type: string | description: Item variant name. 
     - 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 item variants are available. 
  - name: metadata | 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

### listVariants
```javascript
import { itemVariants } from '@wix/restaurants';

async function listVariants(options) {
  const response = await itemVariants.listVariants(options);
};
```

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

async function myListVariantsMethod(options) {
  const elevatedListVariants = auth.elevate(itemVariants.listVariants);
  const response = await elevatedListVariants(options);
}
```

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

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


async function listVariants(options) {
  const response = await myWixClient.itemVariants.listVariants(options);
};
```

---