Categoria

Categoria é a seção de agrupamento de itens de um mesmo segmento (ex: Bebidas), facilitando a visualização do cardápio e busca por itens no aplicativo.

Listando uma categoria

GET

/stores/v1/{store}/menus/categories/{category}

Esta rota retorna as informações de uma categoria específica do cardápio, incluindo detalhes como nome, culinária e lista de complementos.

Para listar as categorias de um cardápio, utilize o Endpoint:

GET

/stores/v1/{store}/menus/categories

Criando categoria

POST

/stores/v1/{store}/menus/categories

Na criação das categorias é obrigatória a escolha de um nome e uma culinária. As demais configurações - promoção, complementos, horário de disponibilidade e taxa de embalagem - são opcionais.

Para editar uma categoria já criada utilize o Endpoint:

PUT

/stores/v1/{store}/menus/categories/{category}

Culinária

As categorias do cardápio são vinculadas a uma culinária, que impacta na exibição dos itens no aplicativo e na inserção dos itens da categoria em campanhas. As culinárias podem ser listadas através do endpoint:

GET

/auxiliaries/v1/culinaries

Horário de disponibilidade

Permite a exibição da categoria no aplicativo num período de horário específico (ex: categorias de menu executivo que só podem ser vendidos de 12:00 às 16:00). Pode-se definir até dois períodos no dia, sendo que o horário de término deve ser posterior ao horário de início e os períodos não podem se sobrepor.

Taxa de embalagem

Caso se aplique, pode-se definir uma taxa de embalagem que será acrescentada ao valor de cada item escolhido pelo cliente no checkout da compra. (Ex: marmitas) Nesse cenário, o valor final de todos os itens da categoria será o preço do item + taxa de embalagem da categoria.

Bloqueio de categorias

As categorias podem ser bloqueadas no cardápio a qualquer momento, o que fará com que deixem de ser exibidos no aplicativo e fiquem indisponíveis para compra.

O bloqueio pode ser feito de duas formas: por tempo indeterminado, tornando a categoria inativa até que seja desbloqueado no cardápio, ou por um período temporário, bloqueando a categoria até 03h00 do dia seguinte.

Para bloquear uma categoria até 03h00 do dia seguinte utilize o Endpoint:

PUT

/stores/v1/{store}/menus/{category}/day-block

Já para bloquear por tempo indeterminado utilize o Endpoint:

PUT

/stores/v1/{store}/menus/{category}/toggle-status

Deletando categoria

DELETE

/stores/v1/{store}/menus/categories/{category}

As categorias podem ser excluídas individualmente a qualquer momento através do endpoint, não podendo ser restauradas.

Criando Pizza Fracionada

1. Criar uma Categoria com culinária Pizza:
   

   Crie uma nova categoria para as pizzas e defina a culinária (culinary_id) dessa categoria igual a "481", isso é essencial para habilitar a funcionalidade de sabores.



2. Configurar Tamanhos (Sizes) com Quantidade de Sabores (flavors_amount):
   

   Ao definir os tamanhos (sizes) da pizza, inclua o atributo flavors_amount. Este atributo indica a quantidade de sabores permitidos para cada tamanho, com um valor entre 1 e 4. Por exemplo:

   
   
   • Pizza de um sabor: flavors_amount: 1 (permite 1 sabor)
   • Pizza de dois sabores: flavors_amount: 2 (permite 2 sabores)
   • Pizza de três sabores: flavors_amount: 3 (permite 3 sabores)
   • Pizza de quatro sabores: flavors_amount: 4 (permite 4 sabores)


3. Configurar Etapas de Itens Obrigatórios
   

   As etapas de itens obrigatórios (complementos obrigatórios) devem ser definidas apenas na categoria de pizza.

   Não defina etapas de itens obrigatórios em cada sabor individualmente. Se você definir em cada sabor, as etapas serão duplicadas ao selecionar os sabores, o que não é desejado.

   
   Exemplo de Configuração:
   
   

   {
     "name": "Pizzas Especiais",
     "culinary_id": "481",
     "sizes": [
       {
         "id": "pequena",
         "name": "Pequena",
         "flavors_amount": 1
       },
       {
         "id": "media",
         "name": "Média",
         "flavors_amount": 2
       },
       {
         "id": "grande",
         "name": "Grande",
         "flavors_amount": 3
       },
       {
         "id": "familia",
         "name": "Família",
         "flavors_amount": 4
       }
     ],
     "mandatories": [
       {
         "name": "Escolha a borda",
         "description": "",
         "order": 1,
         "minimun_limit": 1,
         "maximun_limit": 3,
         "items": [
           {
             "name": "borda 0800",
             "description": "borda tradicioanl",
             "value": 0,
             "id": "#BORDA001",
             "status": true
           },
           {
             "name": "borda queijo",
             "description": "borda queijo",
             "value": 10,
             "id": "#BORDA002",
             "status": true
           }
         ]
       }
     ]
   }