> 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 # ListModifiers # Package: items # Namespace: ModifiersService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/restaurants/menus/items/item-modifiers/list-modifiers.md ## Permission Scopes: Manage Restaurants - all permissions: SCOPE.RESTAURANTS.MEGA-SCOPES ## Introduction > **Note:** The Item Modifier 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 modifiers. --- ## REST API ### Schema ``` Method: listModifiers Description: > **Note:** The Item Modifier 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 modifiers. URL: https://www.wixapis.com/v1/modifiers Method: GET Method parameters: query param name: modifierIds | type: array | description: IDs of the item modifiers to retrieve. param name: paging | type: CursorPaging - name: limit | type: integer | description: Maximum 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: ListModifiersResponse - name: modifiers | type: array | description: Retrieved item modifiers. - name: id | type: string | description: Item modifier GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the item modifier is updated. To prevent conflicting changes, the current revision must be passed when updating the item modifier.
Ignored when creating an item modifier. - name: createdDate | type: string | description: Date and time the item modifier was created. - name: updatedDate | type: string | description: Date and time the item modifier was updated. - name: name | type: string | description: Item modifier display 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: inStock | type: boolean | description: Whether the modifier is in stock. Default: `true`. - 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 modifiers are available. - name: metadata | type: CursorPagingMetadata | description: Metadata of the paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor pointing to the next page and the previous page in the list of results. - 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: Whether 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 ### Retrieve all item modifiers ```curl curl -X GET https://www.wixapis.com/restaurants/item-modifiers/v1/modifiers \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.items.ModifiersService.listModifiers(options) Description: > **Note:** The Item Modifier 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 modifiers. Method parameters: param name: options | type: ListModifiersOptions none - name: modifierIds | type: array | description: IDs of the item modifiers to retrieve. - name: paging | type: CursorPaging | description: Metadata of the paginated results. - name: limit | type: integer | description: Maximum 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 - name: modifiers | type: array | description: Retrieved item modifiers. - name: _id | type: string | description: Item modifier GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the item modifier is updated. To prevent conflicting changes, the current revision must be passed when updating the item modifier.
Ignored when creating an item modifier. - name: _createdDate | type: Date | description: Date and time the item modifier was created. - name: _updatedDate | type: Date | description: Date and time the item modifier was updated. - name: name | type: string | description: Item modifier display 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: inStock | type: boolean | description: Whether the modifier is in stock. Default: `true`. - 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 modifiers are available. - name: metadata | type: CursorPagingMetadata | description: Metadata of the paginated results. - name: count | type: integer | description: Number of items returned in the response. - name: cursors | type: Cursors | description: Cursor pointing to the next page and the previous page in the list of results. - 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: Whether 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 ### listModifiers ```javascript import { itemModifiers } from '@wix/restaurants'; async function listModifiers(options) { const response = await itemModifiers.listModifiers(options); }; ``` ### listModifiers (with elevated permissions) ```javascript import { itemModifiers } from '@wix/restaurants'; import { auth } from '@wix/essentials'; async function myListModifiersMethod(options) { const elevatedListModifiers = auth.elevate(itemModifiers.listModifiers); const response = await elevatedListModifiers(options); } ``` ### listModifiers (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 { itemModifiers } from '@wix/restaurants'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { itemModifiers }, // Include the auth strategy and host as relevant }); async function listModifiers(options) { const response = await myWixClient.itemModifiers.listModifiers(options); }; ``` ---