Itens Adicionais
Criação de Itens Adicionais (Opcionais)
Este endpoint é utilizado para adicionar opções específicas (adicionais) que o cliente pode selecionar a um tamanho (size) existente.
/menu/{store_id}/additional-itemsPayload Criação de Itens Adicionais (Opcionais)
{
"size_id": 4519950,
"additional_items": [
{
"name": "Queijo Extra",
"value": 3,
"sku": "ADD_QUEIJO",
"status": true
}
]
}
Detalhamento do Payload
O payload permite o envio de um ou mais itens adicionais a serem vinculados ao tamanho especificado pelo size_id.
| Campo | Obrigatório | Descrição |
|---|---|---|
size_id | ✅ | ID do Tamanho ao qual o item adicional será vinculado (Ex: 4519950). |
additional_items | ✅ | Array contendo um ou mais objetos de opções/itens a serem criados. |
additional_items[].name | ✅ | Nome da opção (Ex: "Queijo Extra"). |
additional_items[].value | ❌ | Valor adicional da opção (em Reais, Ex: 3.00). |
additional_items[].sku | ❌ | SKU ou código interno da opção. |
additional_items[].status | ❌ | Status de ativação da opção (true ou false). |
Atualização de Item Adicional (Opcional)
Este endpoint é utilizado para modificar os detalhes de uma opção/item específico que pode ser adicionado pelo cliente a um tamanho (size), como o nome, preço ou status de venda.
/menu/{store_id}/additional-items/{id}/menu/{store_id}/additional-items/{id}Payload Atualização de Item Adicional (Opcional)
{
"name": "Queijo Cheddar Extra ",
"value": 5,
"sku": "ADD_QUEIJO_CHEDDAR",
"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 adicional que está sendo atualizado. |
name | ❌ | Novo nome da opção (Ex: "Queijo Cheddar Extra"). |
value | ❌ | Novo valor adicional da opção (em Reais, Ex: 5.00). |
sku | ❌ | Novo SKU ou código interno da opção. |
status | ❌ | Novo status de ativação da opção (true ou false). |
Consulta de Detalhes de Item Adicional (Opcional)
Este endpoint é utilizado para consultar os detalhes de uma opção/item específico que pode ser adicionado pelo cliente a um tamanho (size), confirmando seu preço, status e a qual tamanho ele está vinculado.
/menu/{store_id}/additional-items/{id}Payload Consulta de Detalhes de Item Adicional (Opcional)
{
"data": {
"id": 5542886,
"name": "Queijo Cheddar Extra",
"value": "5.00",
"status": true,
"sku": "ADD_QUEIJO_CHEDDAR",
"size_id": 4519950
}
}
Resposta de Sucesso (Status Code 200)
| Campo Principal | Descrição |
|---|---|
id | ID único do item adicional. |
name | Nome da opção (Ex: "Queijo Cheddar Extra"). |
value | Valor adicional da opção (em string de Real, Ex: "5.00"). |
status | Status de ativação da opção (true ou false). |
sku | SKU ou código interno da opção. |
size_id | ID do Tamanho ao qual este item adicional está vinculado. |
Exclusão de Item Adicional (Opcional)
Este endpoint é utilizado para remover permanentemente uma opção/item que era oferecido como adicional a um tamanho (size) específico.
/menu/{store_id}/additional-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 adicional a ser excluído. |