Skip to main content
PUT
Update a food
Updates a food item in the store. Supplied fields overwrite the existing values. Requires the WRITE_INVENTORY scope.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Path Parameters

id
string
required

ObjectId of the food item to update.

Body

application/json
name
string

Food name (max 100 chars).

price
number

Price (>= 0).

description
string

Food description.

promoPrice
number | null

Promotional price (>= 0); nullable.

images
string[]

Array of image URLs.

video
string | null

Video URL; nullable.

category
string | null

Category ObjectId; nullable.

available
boolean

Whether the item is available to order.

listed
boolean

Whether the item is listed on the menu.

addons
object[]

Add-ons array (replaces existing). Each: name (required), price (required), maxQuantity, image, available, description.

Response

Update a food — success.

status
integer
required
Example:

200

success
boolean
required
Example:

true

message
string
required
Example:

"Update a food"

data
object
required

A restaurant menu item.

Example: