> 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 # GetModifier # Package: items # Namespace: ModifiersService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/restaurants/menus/items/item-modifiers/get-modifier.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 an item modifier by ID. --- ## REST API ### Schema ``` Method: getModifier 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 an item modifier by GUID. URL: https://www.wixapis.com/v1/modifiers/{modifierId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: modifierId Method parameters: param name: modifierId | type: none | required: true Return type: GetModifierResponse - name: modifier | type: Modifier | description: Retrieved item modifier. - 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. ``` ### Examples ### Retrieve an item modifier ```curl curl -X GET https://www.wixapis.com/restaurants/item-modifiers/v1/modifiers/02042f01-58ab-441c-b5db-55f51c855a62 \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.items.ModifiersService.getModifier(modifierId) 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 an item modifier by GUID. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: modifierId Method parameters: param name: modifierId | type: string | description: GUID of the item modifier to retrieve. | required: true Return type: PROMISE - 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. ``` ### Examples ### getModifier ```javascript import { itemModifiers } from '@wix/restaurants'; async function getModifier(modifierId) { const response = await itemModifiers.getModifier(modifierId); }; ``` ### getModifier (with elevated permissions) ```javascript import { itemModifiers } from '@wix/restaurants'; import { auth } from '@wix/essentials'; async function myGetModifierMethod(modifierId) { const elevatedGetModifier = auth.elevate(itemModifiers.getModifier); const response = await elevatedGetModifier(modifierId); } ``` ### getModifier (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 getModifier(modifierId) { const response = await myWixClient.itemModifiers.getModifier(modifierId); }; ``` ---