Skip to main content

Reference

Menu Item Fields

Menu Item Fields

This is a complete reference of all fields on a menu item. Required fields are marked. All other fields are optional but recommended for the best customer experience.

Field Type Required Description
name String Yes The dish name displayed on the menu. Maximum 200 characters.
description String No A short description of the dish. Mention key ingredients and preparation. Two to three sentences recommended.
price Decimal Yes The display price (e.g., 14.99). Shown to customers on the menu.
priceCents Integer Auto Price stored in cents (e.g., 1499). Calculated automatically from the price field. Used internally for precision.
category String No The category this item belongs to (e.g., "Appetizers," "Mains," "Desserts"). Used to group items on the public menu.
photoUrl URL Yes URL of the uploaded photo. Set automatically after upload and AI processing.
isActive Boolean No Whether the item is visible on the public menu. Defaults to true. Set to false to hide without deleting.
position Integer No Sort order within the item's category. Lower numbers appear first. Items without a position are sorted by creation date.
restaurantId UUID Auto The restaurant this item belongs to. Set automatically from your session.
createdAt DateTime Auto Timestamp when the item was created. Set automatically.
updatedAt DateTime Auto Timestamp of the last update. Updated automatically on each save.

3D Model Fields (3D Menu Pro Only)

When using 3D Menu Pro, each menu item may have an associated 3D model with the following additional fields:

Field Type Description
modelUrl URL URL of the optimized GLB model file. Set after processing completes.
status Enum Processing status: PENDING, GENERATING, PROCESSING, READY, or FAILED.
provider String The AI provider used for 3D generation.
providerTaskId String External task ID from the 3D generation provider. Used for status polling.