GET

List Modifiers


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Note: The Item Modifier API only works with the Wix Restaurants Menus (New) app. Make sure you have installed this app from the Wix App Market.

Retrieves a list of up to 100 item modifiers.

Permissions
Manage Bookings Services and Settings
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/restaurants/item-modifiers/v1/modifiers

Query Params
modifierIdsArray <string>

IDs of the item modifiers to retrieve.


paging.limitintegerminimum 0maximum 200format int32

Maximum number of items to load.


paging.cursorstring

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.

Response Object
modifiersArray <Modifier>

Retrieved item modifiers.


metadataMetadata

Metadata of the paginated results.

Retrieve all item modifiers
Request
cURL
curl -X GET https://www.wixapis.com/restaurants/item-modifiers/v1/modifiers \ -H 'Authorization: <AUTH>'
Response
JSON
{ "modifiers": [ { "id": "02042f01-58ab-441c-b5db-55f51c855a62", "revision": "1", "createdDate": "2023-12-03T21:23:33.861Z", "updatedDate": "2023-12-03T21:23:33.861Z", "name": "Tofu", "type": "MODIFIER" }, { "id": "0517e5d4-8fd3-4b28-a743-68cf631e534a", "revision": "1", "createdDate": "2023-12-03T21:23:33.861Z", "updatedDate": "2023-12-03T21:23:33.861Z", "name": "Lettuce", "type": "MODIFIER" }, { "id": "1c1ca051-b460-4064-b7a2-5f9df47f2d3c", "revision": "1", "createdDate": "2023-12-03T21:23:33.861Z", "updatedDate": "2023-12-03T21:23:33.861Z", "name": "Cheese", "type": "MODIFIER" }, { "id": "352a961b-18b9-4f5e-8ec0-c6874f2ab496", "revision": "1", "createdDate": "2023-12-03T21:23:33.861Z", "updatedDate": "2023-12-03T21:23:33.861Z", "name": "Onions", "type": "MODIFIER" }, { "id": "3cf9df4d-580f-4630-b449-60e951405337", "revision": "1", "createdDate": "2023-12-03T21:23:33.861Z", "updatedDate": "2023-12-03T21:23:33.861Z", "name": "Eggs", "type": "MODIFIER" }, { "id": "f6222bdc-1ab2-4cd4-bf6c-8d4fca055d86", "revision": "1", "createdDate": "2023-12-03T21:23:33.861Z", "updatedDate": "2023-12-03T21:23:33.861Z", "name": "Salami", "type": "MODIFIER" } ], "pagingMetadata": { "count": 6, "cursors": {}, "hasNext": false } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?