Nova API V1.0 · Referência
Consultar cardápio publicado
Retorna as seções vendidas ao cliente, seus produtos e, opcionalmente, os grupos de complementos. Com OAuth, exige o escopo `menu:read`; a sessão do restaurante também é aceita sem escopos de integração. O contrato remove registros excluídos, categorias de embalagem e espelhos internos do iFood. Preços, disponibilidade e apresentação são agrupados em objetos. `pricing.resolved.base` aplica a prioridade dos preços do canal; `pricing.resolved.minimum` soma as escolhas obrigatórias. Disponibilidade avalia canal, horários, esgotamento e escolhas válidas. Não retorna objeto de restaurante nem aliases do contrato anterior. Não substitui validação de checkout, abertura da loja ou capacidade de entrega.
Retorna as seções vendidas ao cliente, seus produtos e, opcionalmente,
os grupos de complementos. Com OAuth, exige o escopo menu:read; a
sessão do restaurante também é aceita sem escopos de integração.
O contrato remove registros excluídos, categorias de embalagem e
espelhos internos do iFood. Preços, disponibilidade e apresentação são
agrupados em objetos. pricing.resolved.base aplica a prioridade dos
preços do canal; pricing.resolved.minimum soma as escolhas obrigatórias.
Disponibilidade avalia canal, horários, esgotamento e escolhas válidas.
Não retorna objeto de restaurante nem aliases do contrato anterior.
Não substitui validação de checkout, abertura da loja ou capacidade de entrega.
Authorization
bearerAuth Access token OAuth obtido em POST /oauth/token ou sessão autenticada
do restaurante emitida pelo login Takeat. Tokens OAuth exigem os
escopos de cada operação. A sessão não usa escopos de integração e
fica limitada ao restaurant_id assinado. Chaves tk_ não são aceitas.
In: header
Query Parameters
Omitido para sessões de restaurante, chaves de restaurante e parceiros
ligados a um único restaurante. Obrigatório para parceiros
multi-restaurante e validado contra os restaurantes autorizados para a
credencial. Em uma sessão, um valor diferente do restaurant_id
assinado responde 403.
Canal que define disponibilidade e preço efetivo.
Quando true, remove itens inelegíveis, esgotados, grupos inutilizáveis e seções vazias. False preserva-os com availability.resolved.reason.
Restringe a resposta a uma categoria.
Busca por nome e descrição, sem diferenciar acentos ou caixa.
Restringe às categorias da marca, sempre dentro do restaurante autorizado.
Instante ISO 8601 com Z ou offset explícito; exige channel=delivery. Avalia horários e permissão de agendamento do produto. Sem este parâmetro, usa o instante atual e o canal imediato.
Inclui grupos e opções. False omite a propriedade, mas mantém os mesmos cálculos de preço e disponibilidade.
Inclui fiscal em cada produto, sem alias fiscal_info nem metadados internos.
Response Body
application/json
application/json
application/json
application/json
Revogar um access token POST
Revoga antecipadamente um access ou refresh token. A operação é idempotente. Apps públicos `tk_app_...` enviam `client_id` e não possuem client secret. Para encerrar todas as sessões de uma API key, revogue a chave no AI Builders.
Criar produto POST
Cria um produto em uma categoria não removida do restaurante. Com OAuth, exige `products:write`; a sessão do restaurante também é aceita. Não existe exclusão de produtos nesta API. Uma categoria indisponível pode receber produtos, mas não aparece no menu com only_available=true. Envie preços como números, não strings. Veja a [referência de campos](/externo/v1/campos-do-produto) para padrões de criação e efeitos sobre preços, disponibilidade e esgotamento.