Itens Mandatórios

Criação de Itens Mandatórios

Este endpoint é utilizado para adicionar opções específicas (Ex: "Coca-Cola 600ml", "Sem Borda") a um grupo obrigatório (mandatory-group) já existente.

POST

/menu/{store_id}/mandatory-items

Payload Criação de Itens Mandatórios

{
  "mandatory_group_id": 1388251,
  "mandatory_items": [
    {
      "name": "Coca-Cola 600ml",
      "value": 9.99,
      "sku": "COCA600",
      "status": true
    }
  ]
}

Detalhamento do Payload

O payload permite o envio de um ou mais itens a serem adicionados ao grupo especificado pelo mandatory_group_id.

Campo	Obrigatório	Descrição
mandatory_group_id	✅	ID do Grupo Obrigatório ao qual o item será vinculado (Ex: 1388251).
mandatory_items	✅	Array contendo um ou mais objetos de opções/itens a serem criados.
mandatory_items[].name	✅	Nome da opção (Ex: "Coca-Cola 600ml").
mandatory_items[].value	✅	Valor adicional da opção (em Reais, Ex: 9.99). Use 0.00 se for grátis.
mandatory_items[].sku	❌	SKU ou código interno da opção.
mandatory_items[].status	❌	Status de ativação da opção (true ou false).

Atualização de Grupo Mandatório

Este endpoint é utilizado para modificar os detalhes de uma opção/item específico dentro de um grupo obrigatório (mandatory-group), como o preço de custo ou o nome de exibição.

PUT

/menu/{store_id}/mandatory-items/{id}

PATCH

/menu/{store_id}/mandatory-items/{id}

Payload Atualização de Item Mandatório

{
  "name": "Coca-Cola 600ml updated",
  "value": 17.49,
  "sku": "COCA600-updated",
  "status": true
}

Detalhamento do Payload

A atualização é realizada no corpo da requisição (payload). É recomendado usar PATCH para enviar apenas os campos que se deseja alterar (atualização parcial).

Campo	Obrigatório	Descrição
id (na URL)	✅	ID do item mandatório que está sendo atualizado.
name	❌	Novo nome da opção (Ex: "Coca-Cola 600ml updated").
value	❌	Novo valor adicional da opção (em Reais, Ex: 17.49).
sku	❌	Novo SKU ou código interno da opção.
status	❌	Novo status de ativação da opção (true ou false).

Exclusão de Item Mandatório

Este endpoint é utilizado para remover permanentemente uma opção/item específico de um grupo obrigatório (mandatory-group).

DELETE

/menu/{store_id}/mandatory-items/{id}

Detalhamento do Payload

A exclusão é realizada diretamente através da URL, não sendo necessário um corpo (payload).

Parâmetro	Tipo	Obrigatório	Descrição
store_id (na URL)	Integer	✅	O ID da loja.
id (na URL)	Integer	✅	O ID único do item mandatório a ser excluído.