GET

List Items


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 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 500 items.

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

Query Params
itemIdsArray <string>

Item IDs.


paging.limitintegerminimum 0maximum 500format int32

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.


onlyVisibleboolean

Whether to return only items that are visible to site visitors.

Response Object
itemsArray <Item>

Items.


pagingMetadataPagingMetadata

The metadata of the paginated results.

List Items
Request
cURL
curl -X GET https://www.wixapis.com/restaurants/menus-item/v1/items \ -H 'Authorization: <AUTH>'
Response
JSON
{ "items": [ { "id": "02042f01-58ab-441c-b5db-55f51c855a62", "revision": "1", "createdDate": "2023-12-03T21:23:33.861Z", "updatedDate": "2023-12-03T21:23:33.861Z", "name": "Tofu skewers", "description": "Grilled tofu skewers, marinated in a blend of soy and sesame with seasonal roast vegetables", "priceInfo": {"price": "7.50"}, "image": { "id": "ec845c_70984dcdfdea4c669ffd5536259a8a78~mv2.jpg", "url": "https://static.wixstatic.com/media/ec845c_70984dcdfdea4c669ffd5536259a8a78~mv2.jpg", "height": 3335, "width": 5000 }, "additionalImages": [], "labels": [ { "id": "6046e53c-4ce3-41f7-9e2a-0f7352fe4975" } ], "orderSettings": { "inStock": false, "acceptSpecialRequests": true, }, "modifierGroups": [ { "id": "481135f7-1392-4a2e-ac6b-12fb0ef398b7" } ] }, { "id": "0517e5d4-8fd3-4b28-a743-68cf631e534a", "revision": "1", "createdDate": "2023-12-03T21:23:33.861Z", "updatedDate": "2023-12-03T21:23:33.861Z", "name": "Classic burger", "description": "Our classic burger with lettuce, pickles, heirloom tomatoes, served with a side of fries", "priceVariants": { "variants": [ { "variantId": "ef7dc1ed-06df-481a-8ecc-ad87ef9b6b0c", "priceInfo": {"price": "7.00"} }, { "variantId": "869315e7-f1c8-428b-aff0-68bf2d7af067", "priceInfo": {"price": "7.50"} }, { "variantId": "b719995f-fed6-469d-9330-4b9ea9662edf", "priceInfo": {"price": "9.00"} } ] }, "image": { "id": "ec845c_e3be4aec9afe4edaa505e903d8e13344~mv2.jpg", "url": "https://static.wixstatic.com/media/ec845c_e3be4aec9afe4edaa505e903d8e13344~mv2.jpg", "height": 3335, "width": 5000 }, "additionalImages": [], "labels": [], "orderSettings": { "inStock": false, "acceptSpecialRequests": true, }, "modifierGroups": [] }, { "id": "1c1ca051-b460-4064-b7a2-5f9df47f2d3c", "revision": "1", "createdDate": "2023-12-03T21:23:33.861Z", "updatedDate": "2023-12-03T21:23:33.861Z", "name": "Classic cheesecake", "description": "Topped with a layer of raspberry jam & sliced strawberries", "priceInfo": {"price": "6.5"} "image": { "id": "ec845c_812f7b1744e34a038f7e92148c029d71~mv2.jpg", "url": "https://static.wixstatic.com/media/ec845c_812f7b1744e34a038f7e92148c029d71~mv2.jpg", "height": 3335, "width": 5000 }, "additionalImages": [], "labels": [], "orderSettings": { "inStock": false, "acceptSpecialRequests": true, }, "modifierGroups": [] }, { "id": "352a961b-18b9-4f5e-8ec0-c6874f2ab496", "revision": "1", "createdDate": "2023-12-03T21:23:33.861Z", "updatedDate": "2023-12-03T21:23:33.861Z", "name": "Sticky date & ice cream", "description": "Served with vanilla ice cream, toffee sauce & a peanut crumble", "priceInfo": {"price": "7.00"}, "image": { "id": "ec845c_ee7a6fde34d8470582ec419484f74dd9~mv2.jpg", "url": "https://static.wixstatic.com/media/ec845c_ee7a6fde34d8470582ec419484f74dd9~mv2.jpg", "height": 3335, "width": 5000 }, "additionalImages": [], "labels": [ { "id": "c05c3ba3-0917-4257-ac8b-4677a754bfbb" } ], "orderSettings": { "inStock": false, "acceptSpecialRequests": true, }, "modifierGroups": [] }, { "id": "3cf9df4d-580f-4630-b449-60e951405337", "revision": "1", "createdDate": "2023-12-03T21:23:33.861Z", "updatedDate": "2023-12-03T21:23:33.861Z", "name": "Tuna sashimi", "description": "Seared fresh tuna, fresh herbs, and a touch of chili", "priceVariants": { "variants": [ { "variantId": "6c5d9953-a538-4a58-9319-71e624cce5d7", "priceInfo": {"price": "5.00"} }, { "variantId": "e5d0a389-d930-439e-b90a-5aae81c7691c", "priceInfo": {"price": "7.00"} } ] }, "image": { "id": "ec845c_ed32ae3532964072b9b332e0989bdbf5~mv2.jpg", "url": "https://static.wixstatic.com/media/ec845c_ed32ae3532964072b9b332e0989bdbf5~mv2.jpg", "height": 3335, "width": 5000 }, "additionalImages": [], "labels": [], "orderSettings": { "inStock": true, "acceptSpecialRequests": true, }, "modifierGroups": [ { "id": "0f19aead-1d2b-4421-9188-faefdea5bb36" }, { "id": "02d34a88-37e9-42b2-8b63-6eda85d73459" } ] }, { "id": "f6222bdc-1ab2-4cd4-bf6c-8d4fca055d86", "revision": "1", "createdDate": "2023-12-03T21:23:33.861Z", "updatedDate": "2023-12-03T21:23:33.861Z", "name": "Healthy smoothie", "description": "Nourish your body with our selection of healthy smoothies", "priceInfo": {"price": "3.00"}, "image": { "id": "", "url": "", "height": 0, "width": 0 }, "additionalImages": [], "labels": [], "orderSettings": { "inStock": false, "acceptSpecialRequests": true, }, "modifierGroups": [] } ], "pagingMetadata": { "count": 23, "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?