Pular para o conteúdo principal

Referência

Campos dos itens do cardápio

Campos dos itens do cardápio

Esta é uma referência completa de todos os campos de um item do cardápio. Os campos obrigatórios estão indicados. Todos os demais campos são opcionais, mas recomendados para oferecer a melhor experiência ao cliente.

Campo Tipo Obrigatório Descrição
name String Sim O nome do prato exibido no cardápio. Máximo de 200 caracteres.
description String Não Uma descrição curta do prato. Mencione os principais ingredientes e o preparo. Recomendam-se de duas a três frases.
price Decimal Sim O preço de exibição (por exemplo, 14.99). Mostrado aos clientes no cardápio.
priceCents Inteiro Automático Preço armazenado em centavos (por exemplo, 1499). Calculado automaticamente a partir do campo de preço. Usado internamente para maior precisão.
category String Não A categoria à qual este item pertence (por exemplo, "Entradas", "Pratos principais", "Sobremesas"). Usada para agrupar os itens no cardápio público.
photoUrl URL Sim URL da foto enviada. Definida automaticamente após o envio e o processamento por IA.
isActive Booleano Não Indica se o item está visível no cardápio público. O padrão é true. Defina como false para ocultá-lo sem excluir.
position Inteiro Não Ordem de classificação dentro da categoria do item. Números menores aparecem primeiro. Itens sem posição são ordenados pela data de criação.
restaurantId UUID Automático O restaurante ao qual este item pertence. Definido automaticamente a partir da sua sessão.
createdAt DateTime Automático Data e hora em que o item foi criado. Definido automaticamente.
updatedAt DateTime Automático Data e hora da última atualização. Atualizado automaticamente a cada salvamento.

Campos do modelo 3D (somente 3D Menu Pro)

Ao usar o 3D Menu Pro, cada item do cardápio pode ter um modelo 3D associado com os seguintes campos adicionais:

Campo Tipo Descrição
modelUrl URL URL do arquivo de modelo GLB otimizado. Definida após a conclusão do processamento.
status Enum Status do processamento: PENDING, GENERATING, PROCESSING, READY ou FAILED.
provider String O provedor de IA usado para a geração 3D.
providerTaskId String ID da tarefa externa no provedor de geração 3D. Usado para consultar o status.