# Cardápio Web API

> Documentação oficial da API de integração da Cardápio Web.

## Docs

- [Atualizar categoria](https://docs.cardapioweb.com/api-reference/catalogo/categorias/atualizar-categoria.md): Atualiza os dados de uma categoria existente. Apenas os campos enviados serão atualizados.
- [Consultar categoria](https://docs.cardapioweb.com/api-reference/catalogo/categorias/consultar-categoria.md): Retorna os detalhes de uma categoria específica, incluindo seus itens.
- [Criar categoria](https://docs.cardapioweb.com/api-reference/catalogo/categorias/criar-categoria.md): Cria uma nova categoria no cardápio. O nome deve ser único no estabelecimento.
- [Excluir categoria](https://docs.cardapioweb.com/api-reference/catalogo/categorias/excluir-categoria.md): Exclui uma categoria e todos os seus itens. Complementos e opções não são excluídos, eles apenas são desvinculados dos itens aos quais estavam associados.
- [Listar categorias](https://docs.cardapioweb.com/api-reference/catalogo/categorias/listar-categorias.md): Retorna a lista paginada de categorias do estabelecimento, incluindo seus itens.
- [Consultar catálogo completo](https://docs.cardapioweb.com/api-reference/catalogo/consultar-catalogo-completo.md): Retorna o catálogo completo do estabelecimento incluindo categorias, itens e complementos.
- [Atualizar grupo de complementos](https://docs.cardapioweb.com/api-reference/catalogo/grupos-de-complementos/atualizar-grupo-de-complementos.md): Atualiza os dados de um grupo de complementos existente.
- [Consultar grupo de complementos](https://docs.cardapioweb.com/api-reference/catalogo/grupos-de-complementos/consultar-grupo-de-complementos.md): Retorna os detalhes de um grupo de complementos, incluindo suas opções.
- [Criar grupo de complementos](https://docs.cardapioweb.com/api-reference/catalogo/grupos-de-complementos/criar-grupo-de-complementos.md): Cria um novo grupo de complementos. Opcionalmente, já associa opções existentes ao grupo.
- [Excluir grupo de complementos](https://docs.cardapioweb.com/api-reference/catalogo/grupos-de-complementos/excluir-grupo-de-complementos.md): Exclui um grupo de complementos e remove todas as suas associações com itens e opções. Os itens e opções não são excluídos.
- [Listar grupos de complementos](https://docs.cardapioweb.com/api-reference/catalogo/grupos-de-complementos/listar-grupos-de-complementos.md): Retorna a lista paginada de grupos de complementos do estabelecimento, incluindo suas opções.
- [Remover imagem](https://docs.cardapioweb.com/api-reference/catalogo/imagens/remover-imagem.md): Remove a imagem de um recurso (categoria, item ou opção).
- [Upload de imagem](https://docs.cardapioweb.com/api-reference/catalogo/imagens/upload-de-imagem.md): Faz upload de uma imagem para um recurso (categoria, item ou opção). A imagem deve ser enviada via `multipart/form-data`.
- [Atualizar item](https://docs.cardapioweb.com/api-reference/catalogo/itens/atualizar-item.md): Atualiza os dados de um item existente. Apenas os campos enviados serão atualizados.
- [Consultar item](https://docs.cardapioweb.com/api-reference/catalogo/itens/consultar-item.md): Retorna os detalhes completos de um item.
- [Criar item](https://docs.cardapioweb.com/api-reference/catalogo/itens/criar-item.md): Cria um novo item no cardápio. O nome deve ser único no estabelecimento.
- [Excluir item](https://docs.cardapioweb.com/api-reference/catalogo/itens/excluir-item.md): Exclui um item do cardápio. Complementos e opções não são excluídos, eles apenas são desvinculados do item.
- [Listar itens](https://docs.cardapioweb.com/api-reference/catalogo/itens/listar-itens.md): Retorna a lista paginada de itens do estabelecimento.
- [Atualizar opção](https://docs.cardapioweb.com/api-reference/catalogo/opções/atualizar-opção.md): Atualiza os dados de uma opção existente. Apenas os campos enviados serão atualizados.
- [Consultar opção](https://docs.cardapioweb.com/api-reference/catalogo/opções/consultar-opção.md): Retorna os detalhes de uma opção específica.
- [Criar opção](https://docs.cardapioweb.com/api-reference/catalogo/opções/criar-opção.md): Cria uma nova opção. O nome deve ser único no estabelecimento.
- [Excluir opção](https://docs.cardapioweb.com/api-reference/catalogo/opções/excluir-opção.md): Exclui (soft delete) uma opção. Ela será removida de todos os grupos de complementos onde estava associada.
- [Listar opções](https://docs.cardapioweb.com/api-reference/catalogo/opções/listar-opções.md): Retorna a lista paginada de opções do estabelecimento.
- [Listar avaliações](https://docs.cardapioweb.com/api-reference/loja/avaliações/listar-avaliações.md): Retorna a lista de avaliações do estabelecimento.
- [Buscar cliente](https://docs.cardapioweb.com/api-reference/loja/clientes/buscar-cliente.md): Buscar informações de um cliente do estabelecimento.
- [Listar clientes](https://docs.cardapioweb.com/api-reference/loja/clientes/listar-clientes.md): Retorna todos os clientes do estabelecimento.
- [Criar cupom](https://docs.cardapioweb.com/api-reference/loja/cupons/criar-cupom.md): Criar um novo cupom para o estabelecimento.
- [Editar cupom](https://docs.cardapioweb.com/api-reference/loja/cupons/editar-cupom.md): Editar um novo cupom do estabelecimento.
- [Listar cupons](https://docs.cardapioweb.com/api-reference/loja/cupons/listar-cupons.md): Retorna todos os cupons de desconto do estabelecimento.
- [Consultar loja](https://docs.cardapioweb.com/api-reference/loja/loja/consultar-loja.md): Retorna informações do estabelecimento como endereço, horários de funcionamento, formas de pagamento aceitas, dentre outras.
- [Aceitar pedido](https://docs.cardapioweb.com/api-reference/pedidos/aceitar-pedido.md): Aceita o pedido especificado pelo order_id.
- [Cancelar pedido](https://docs.cardapioweb.com/api-reference/pedidos/cancelar-pedido.md): Cancela o pedido especificado pelo order_id.
- [Consultar detalhes do pedido](https://docs.cardapioweb.com/api-reference/pedidos/consultar-detalhes-do-pedido.md): Retorna todas as informações sobre um determinado pedido a partir do seu ID.
- [Criar pedido pré-preenchido](https://docs.cardapioweb.com/api-reference/pedidos/criar-pedido-pré-preenchido.md): Cria um pedido pré-preenchido e retorna um link para que o cliente possa finalizar o pedido através do site.
- [Finalizar pedido](https://docs.cardapioweb.com/api-reference/pedidos/finalizar-pedido.md): Finaliza o pedido especificado pelo order_id.
- [Histórico de pedidos](https://docs.cardapioweb.com/api-reference/pedidos/histórico-de-pedidos.md): Retorna os pedidos concluídos e cancelados do estabelecimento que foram criados dentro de um período especificado. O início desse período não pode retroceder mais de um ano, e a duração do período não pode exceder seis meses.
- [Iniciar preparação (agendamento)](https://docs.cardapioweb.com/api-reference/pedidos/iniciar-preparação-agendamento.md): Inicia a preparação de um pedido de agendamento do pedido especificado pelo order_id.
- [Pedido entregue](https://docs.cardapioweb.com/api-reference/pedidos/pedido-entregue.md): Indica que o pedido especificado pelo order_id foi entregue.
- [Pedido pronto](https://docs.cardapioweb.com/api-reference/pedidos/pedido-pronto.md): Indica que o pedido especificado pelo order_id está pronto para retirada ou saiu para entrega.
- [Polling de pedidos](https://docs.cardapioweb.com/api-reference/pedidos/polling-de-pedidos.md): Retorna os pedidos do estabelecimento modificados nas últimas 8 horas.
- [Fluxos de integração](https://docs.cardapioweb.com/fluxo-integracao.md): Como integrar os módulos de Loja, Catálogo e Pedidos, incluindo polling, webhooks e alteração de status.
- [Introdução](https://docs.cardapioweb.com/index.md): Documentação oficial da API de integração da Cardápio Web.
- [Sobre a API](https://docs.cardapioweb.com/sobre-a-api.md): Visão geral da API RESTful da Cardápio Web, ambientes, autenticação, códigos HTTP e rate limits.
- [Eventos notificados](https://docs.cardapioweb.com/webhooks/eventos.md): Estrutura e tipos de eventos de webhook enviados pelo módulo de Pedidos.
- [Visão geral](https://docs.cardapioweb.com/webhooks/visao-geral.md): Como configurar webhooks, autenticar notificações e garantir entrega com HTTP 200.

## OpenAPI Specs

- [api-pedidos](https://docs.cardapioweb.com/reference/api-pedidos.json)
- [api-loja](https://docs.cardapioweb.com/reference/api-loja.json)
- [api-catalogo](https://docs.cardapioweb.com/reference/api-catalogo.json)