Saltar al contenido principal

Referencia

Campos de los artículos del menú

Campos de los artículos del menú

Esta es una referencia completa de todos los campos de un artículo del menú. Los campos obligatorios están marcados. Todos los demás campos son opcionales, pero se recomiendan para ofrecer la mejor experiencia al cliente.

Campo Tipo Obligatorio Descripción
name String Sí El nombre del platillo que se muestra en el menú. Máximo 200 caracteres.
description String No Una breve descripción del platillo. Mencione los ingredientes clave y la preparación. Se recomiendan de dos a tres oraciones.
price Decimal Sí El precio que se muestra (p. ej., 14.99). Se muestra a los clientes en el menú.
priceCents Integer Automático Precio almacenado en centavos (p. ej., 1499). Se calcula automáticamente a partir del campo de precio. Se usa internamente para mayor precisión.
category String No La categoría a la que pertenece este artículo (p. ej., "Entradas", "Platos fuertes", "Postres"). Se usa para agrupar los artículos en el menú público.
photoUrl URL Sí URL de la foto subida. Se establece automáticamente después de la carga y el procesamiento con IA.
isActive Boolean No Indica si el artículo es visible en el menú público. El valor predeterminado es true. Establézcalo en false para ocultarlo sin eliminarlo.
position Integer No Orden dentro de la categoría del artículo. Los números más bajos aparecen primero. Los artículos sin posición se ordenan por fecha de creación.
restaurantId UUID Automático El restaurante al que pertenece este artículo. Se establece automáticamente a partir de su sesión.
createdAt DateTime Automático Marca de tiempo de la creación del artículo. Se establece automáticamente.
updatedAt DateTime Automático Marca de tiempo de la última actualización. Se actualiza automáticamente cada vez que se guarda.

Campos del modelo 3D (solo 3D Menu Pro)

Al usar 3D Menu Pro, cada artículo del menú puede tener un modelo 3D asociado con los siguientes campos adicionales:

Campo Tipo Descripción
modelUrl URL URL del archivo del modelo GLB optimizado. Se establece cuando termina el procesamiento.
status Enum Estado del procesamiento: PENDING, GENERATING, PROCESSING, READY o FAILED.
provider String El proveedor de IA que se usó para la generación 3D.
providerTaskId String ID externo de la tarea del proveedor de generación 3D. Se usa para consultar el estado.