PATCH

Update Item


Developer Preview

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

Updates an item. You can't update archived items.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurant Catalogs
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/restaurants/v3/catalogs/{catalogId}/items/{item.id}

Path Params
catalogIdstringRequired

ID of the catalog the item belongs to.


item.idstringRequired

Item ID.

Body Params
itemItem

Item to update.

Response Object
itemItem

Updated Item.

Update Item
Request
cURL
curl -X PATCH \ 'https://www.wixapis.com/restaurants/v3/catalogs/4d088f16-d341-44b2-ac69-ae8f3e8897fd/items/865925f8-c284-47a8-97d1-8b71b5a6c8d8' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ --data-raw '{ "item": { "price": { "value": "12.00" }, "taxRate": "10.00" } }'
Response
JSON
{ "item": { "id": "865925f8-c284-47a8-97d1-8b71b5a6c8d8", "name": "MARGHERITA", "description": "This is an item on your menu. Give your item a brief description", "price": { "value": "12.00", "currency": "USD" }, "imageUrl": null, "labels": { "values": ["featured"] }, "inStock": true, "archived": false, "visibilityCriteria": { "visible": true, "fulfillmentTypes": ["DELIVERY", "PICKUP_OR_DINE_IN"], "platforms": [ "WIX_APP", "CALL_CENTER", "CHAT_BOT", "MOBILE_SITE", "SITE" ], "availability": null }, "dishOptions": { "values": [ { "name": "Toppings", "extras": { "defaultChoices": [], "minChoices": 0, "maxChoices": 3, "availableChoices": [ { "itemId": "393d56b1-55ac-43de-8493-5e935bc8663f", "price": { "value": "1.00", "currency": "USD" } }, { "itemId": "089c1868-3dc4-4633-ad93-3404607add28", "price": { "value": "2.00", "currency": "USD" } }, { "itemId": "1a4a1fd0-3029-46df-819b-e3d22dabb5aa", "price": { "value": "3.00", "currency": "USD" } } ] }, "type": "EXTRAS" } ] }, "taxRate": "10.00", "acceptSpecialRequest": true, "type": "DISH" } }
Errors

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

Did this help?