Pular para o conteúdo principal

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.

POST
/menu/{store_id}/additional-items

Payload 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.


CampoObrigatórioDescrição
size_idID do Tamanho ao qual o item adicional será vinculado (Ex: 4519950).
additional_itemsArray contendo um ou mais objetos de opções/itens a serem criados.
additional_items[].nameNome da opção (Ex: "Queijo Extra").
additional_items[].valueValor adicional da opção (em Reais, Ex: 3.00).
additional_items[].skuSKU ou código interno da opção.
additional_items[].statusStatus 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.

PUT
/menu/{store_id}/additional-items/{id}

PATCH
/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).


CampoObrigatórioDescrição
id (na URL)ID do item adicional que está sendo atualizado.
nameNovo nome da opção (Ex: "Queijo Cheddar Extra").
valueNovo valor adicional da opção (em Reais, Ex: 5.00).
skuNovo SKU ou código interno da opção.
statusNovo 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.

GET
/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 PrincipalDescrição
idID único do item adicional.
nameNome da opção (Ex: "Queijo Cheddar Extra").
valueValor adicional da opção (em string de Real, Ex: "5.00").
statusStatus de ativação da opção (true ou false).
skuSKU ou código interno da opção.
size_idID 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.

DELETE
/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âmetroTipoObrigatórioDescrição
store_id (na URL)IntegerO ID da loja.
id (na URL)IntegerO ID único do item adicional a ser excluído.

aiqfome

© Copyright 2007-2026 aiqfome LTDA .