Referência da Nova API V1.0

Restaurante

Dados e gestão das lojas e endpoints compartilhados de tokens.

Autenticação3 métodos

getListar lojas acessíveis pela credencialAceita somente access token de integração. Retorna IDs e nomes públicos da concessão atual, intersectada com os vínculos ativos de multilojas. Não aceita chave bruta ou sessão humana. Não exige novo escopo. Concessões universais devem escolher um tenant e não podem enumerar todas as lojas.postEmitir ou renovar tokensSuporta duas formas de iniciar uma sessão: - API key: envie a chave completa `tk_live_...` ou `tk_test_...` como `api_key` com `grant_type=api_key`. Não informe `client_id` ou `client_secret`. - App instalável: envie o código recebido no callback, o client ID público, a redirect URI exata e o `code_verifier` com `grant_type=authorization_code`. O app não possui client secret. O parâmetro `scope` restringe o token a um subconjunto dos escopos da chave no grant `api_key`. A resposta contém um access token curto e um refresh token rotativo. Para renovar uma sessão de API key, envie somente o refresh token atual. Para um app instalável, envie o refresh token atual e seu `client_id`. Sempre substitua o refresh token pelo novo valor da resposta. Alterar as permissões de um app instalável (adição ou remoção de escopos) revoga todas as autorizações e tokens existentes, mantendo o client ID. Códigos e refresh tokens anteriores retornam `invalid_grant`; os access tokens anteriores deixam de acessar os recursos. Cada restaurante deve repetir o consentimento com PKCE para obter tokens com as permissões atuais. postRevogar um access tokenRevoga 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.

Takeat Store3 métodos

getConsultar avaliações do app conectadoO client_id do token e sua instalação identificam o app; não aceita ID de outro aplicativo. Exige OAuth PKCE de restaurante com instalação ativa, não expirada e app visível. Não exige escopo adicional. Sem restaurant_id, lista todas as avaliações do app. Com o filtro, lista e resumo incluem somente uma loja autorizada na conexão e nos vínculos atuais da rede. Retorna 10 avaliações por página, da mais recente para a mais antiga. IDs de contas e e-mails não são publicados. Avaliações excluídas logicamente não aparecem em data, ownReview, totais ou médias. postCriar ou atualizar avaliação do app conectadoO token identifica o app e as lojas autorizadas. Cria ou atualiza uma única avaliação por aplicativo e restaurante, retornando 200 nos dois casos. Se ela foi excluída logicamente, restaura o mesmo registro com a nova nota e comentário. Sem restaurant_id, infere a loja se o token autoriza somente uma; com várias lojas, o seletor é obrigatório. A nota e o comentário devem ser escolhidos pelo usuário antes do envio. O autor é o usuário do consentimento ou o dono registrado da rede, com acesso ativo verificado. Conexões sem esse usuário precisam passar novamente pelo consentimento. App e instalação são verificados e bloqueados na transação de gravação. Não exige escopo adicional e não aceita IDs de autor ou app no corpo. deleteExcluir avaliação do próprio restauranteExige uma conexão OAuth de restaurante ativa. O client_id do token identifica o app e o restaurante selecionado deve ser autorizado na conexão e nos vínculos atuais da rede. Só exclui uma avaliação de autoria desse restaurante nesse aplicativo; o usuário individual que escreveu a avaliação não precisa ser o mesmo responsável atual. Registra deleted_at e updated_at, preservando a linha e seu conteúdo. A avaliação deixa de aparecer nas consultas, totais, médias e ownReview da API e da Store. Um novo POST restaura o mesmo registro. Avaliações inexistentes, já excluídas ou de outro app/restaurante retornam o mesmo 404. Não exige escopo adicional.

Restaurante1 método

getConsultar status e funcionalidades do restauranteExige OAuth restaurants:read ou sessão do próprio restaurante. Lê o primário sem cache. is_active é a ativação da conta, não abertura da loja. features contém 26 capacidades exportáveis agrupadas por produto; available_features fica vazio para contas inativas. Não verifica provedores, expiração de testes ou permissões individuais, nem concede acesso a outras rotas. A seleção é limitada à autorização atual; não modifica configurações.

Marcas1 método

getListar marcas do restauranteOAuth exige brands:read; também aceita sessão autenticada de restaurante. Retorna marcas não excluídas, ativas ou inativas, ordenadas por padrão primeiro, nome e id. Não expõe credenciais fiscais nem cursor de distribuição.

Cardápio1 método

getConsultar cardápio publicadoRetorna 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.

Pedidos3 métodos

getListar sessões de comandaRetorna comandas abertas e fechadas com contas, pedidos, pagamentos e dados fiscais. O intervalo máximo é de três dias e as datas são UTC. Com OAuth, exige o escopo `table-sessions:read`; a sessão do restaurante também é aceita sem escopos de integração. A resposta preserva o contrato publicado: chaves `snake_case`, valores monetários como strings com escala e relações aninhadas. `status_timings` sempre está presente e agrupa os horários persistidos do ciclo do pedido. Etapas ainda não atingidas retornam `null`; a API não infere transições ausentes nem calcula durações. `bills[].buyer.delivery_address` é o destino selecionado pela sessão por `buyer_delivery_address_id`, nunca um endereço arbitrário do cadastro do comprador. Retorna null para sessões sem entrega, retirada, destino ausente ou de outro restaurante; um comprador ausente também permanece null. `motoboy_id` filtra pelo entregador atribuído à sessão, dentro do mesmo restaurante, mantendo todos os pedidos aninhados. Pode ser combinado com `brand_id`; as datas continuam obrigatórias. IDs sem correspondência ou de outro restaurante retornam lista vazia. `motoboy_id` e `motoboy` sempre estão presentes. O objeto contém apenas `id`, `name` e `phone`, com contatos anuláveis. Ambos retornam null para vínculos ausentes ou contraditórios, inclusive de outro restaurante. Atribuições históricas permanecem disponíveis para entregadores arquivados. `intended_payments` sempre está presente e concentra `payment_method`, `change_for`, `is_prepaid` e `ifood_paid`, mesmo antes de existir um pagamento. A forma é uma intenção; no checkout nativo, `change_for` representa "troco para", não troco já devolvido. `payments` continua contendo somente os pagamentos registrados. `session_number` é a sequência anulável da comanda no restaurante, distinta do ID interno e de `attendance_password`. getListar sessões de comanda (V2 paginada)Comandas, contas, pedidos, pagamentos e dados fiscais em páginas ordenadas por ID. Datas UTC, sem limite de dias na V2. limit: padrão 50, máximo 100; cursor vinculado à loja e aos filtros. Continue com pagination.next até has_more=false. Cada sessão inclui o objeto intended_payments (payment_method, change_for, is_prepaid, ifood_paid), separado de payments. No checkout nativo, change_for significa troco para, não o troco devolvido. A V1 mantém seu envelope anterior.getConsultar uma sessão de comandaRetorna uma sessão aberta ou fechada, com o mesmo objeto e relações da listagem: pedidos, contas, pagamentos, troco, previsão de recebimento, códigos de complementos, dados fiscais, status_timings e motoboy. Não exige intervalo de datas. O ID interno é combinado com o restaurante autorizado e, quando informado, brand_id. Sessões ausentes, de outra loja ou fora da marca selecionada retornam o mesmo 404 table_session_not_found. Exige table-sessions:read com OAuth ou uma sessão verificada do restaurante.

Catálogo22 métodos

Avaliações1 método

getListar avaliações do restauranteOAuth exige ratings:read; aceita sessão autenticada do próprio restaurante. Retorna todas as origens por padrão, inclusive Clube. O filtro channel é literal e opcional; use channel=clube nesta mesma rota para avaliações atuais do Clube integradas ao Takeat. O histórico antigo do banco próprio do api-clube não é incluído. Datas YYYY-MM-DD obrigatórias, inclusivas em UTC, máximo de 92 dias. Ordenação por created_at e id decrescentes. Resumo sobre todo o período e filtros, independente da página. Pode conter nome e telefone do cliente, quando disponíveis. Preserve os filtros ao aplicar pagination.next. A leitura pode refletir atraso da réplica.

Clientes1 método

getListar clientes vinculados ao restauranteExige `clients:read` no access token OAuth ou sessão autenticada do restaurante. Lista buyers vinculados, inclusive importados e sem compras. O ID público é buyers.id, preservado após cadastro no Clube. Pessoas existentes somente no Clube não entram. Telefones brasileiros são normalizados com DDI 55, sem inferir DDD ou nono dígito. O filtro de cadastro ativo na loja é aplicado antes de contar e paginar. Ordenação por ID crescente. Compras são sessões finished/completed ou deliveries delivered/finished, mesmo abertos, excluindo pedidos cancelados. Total gasto soma somente cestas atribuídas ao buyer, com fallback para o buyer da conta individual, sem frete, taxas ou pagamentos separados. Não consulta números intermediários de marketplace. Não altera cadastros ou saldos. Sem Clube configurado: registered_in_clube false, clube e cashback null. Indisponibilidade, timeout ou resposta inválida do Clube falha integralmente com 502 clube_unavailable. A rota GET /v1/clube/clients mantém seu contrato independente.

Clube de Fidelidade2 métodos

getListar clientes do Clube de FidelidadeRetorna uma página de clientes do Clube. Com OAuth, exige o escopo `clube:read`; a sessão do restaurante também é aceita. O restaurante precisa ter o Clube configurado. getListar clientes do Clube de Fidelidade (V2 paginada)Retorna uma página de clientes do Clube. Com OAuth, exige o escopo `clube:read`; a sessão do restaurante também é aceita. O restaurante precisa ter o Clube configurado. Retorna data e pagination; siga pagination.next mantendo os filtros. A V1 permanece disponível com seu contrato anterior.

Estoque25 métodos

Financeiro2 métodos

getListar lançamentos financeirosReplica os lançamentos da Área do Gestor, com pais e itens aninhados, totais do período e página fixa de 100. Com OAuth, exige `financial:read`; a sessão do restaurante também é aceita. getListar lançamentos financeiros (V2 paginada)Replica os lançamentos da Área do Gestor, com pais e itens aninhados, totais do período e página fixa de 100. Com OAuth, exige `financial:read`; a sessão do restaurante também é aceita. Retorna data e pagination; siga pagination.next mantendo os filtros. A V1 permanece disponível com seu contrato anterior.

Fiscal2 métodos

getListar NF-e recebidasOAuth exige nfe-received:read; também aceita sessão autenticada de restaurante. Somente notas autorizada e sem cancelamento local, por emissão crescente e id. Intervalo máximo de 92 dias. Array completo, sem paginação; divida intervalos muito grandes. Não inclui transferências de estoque nem solicita manifestação. Valores locais podem diferir da consulta atual do detalhe.getConsultar detalhe de NF-e recebidaOAuth exige nfe-received:read; também aceita sessão autenticada de restaurante. Consulta a Focus no servidor usando a marca vinculada ou padrão quando a nota não possui marca. Não modifica a nota nem manifesta. Usa timeout de 15 segundos e resposta máxima de 5 MiB. Nota resumida pode retornar invoice/protocol null. Campos locais de correção, cancelamento e referências continuam sendo snapshots locais. Erros do provedor não são expostos.

Garçom

Consultas limitadas ao atendimento, com autorização OAuth pessoal e PKCE.

Perfil1 método

getConsultar meu perfilExige autorização OAuth pessoal de garçom. A loja vem da concessão; não envie restaurante, identidade alternativa ou corpo. Retorna apenas campos públicos aprovados, sem dados pessoais dos clientes, observações livres, chaves de sessão, dados de pagamentos ou configuração de terminais.

Cardápio3 métodos

getConsultar cardápio publicadoExige autorização OAuth pessoal de garçom. A loja vem da concessão; não envie restaurante, identidade alternativa ou corpo. Retorna apenas campos públicos aprovados, sem dados pessoais dos clientes, observações livres, chaves de sessão, dados de pagamentos ou configuração de terminais. Canal presencial, somente itens disponíveis, escolhas incluídas e dados fiscais desabilitados.getListar marcas ativasExige autorização OAuth pessoal de garçom. A loja vem da concessão; não envie restaurante, identidade alternativa ou corpo. Retorna apenas campos públicos aprovados, sem dados pessoais dos clientes, observações livres, chaves de sessão, dados de pagamentos ou configuração de terminais.getListar marcas ativas (V2 paginada)Exige autorização OAuth pessoal de garçom. A loja vem da concessão; não envie restaurante, identidade alternativa ou corpo. Retorna apenas campos públicos aprovados, sem dados pessoais dos clientes, observações livres, chaves de sessão, dados de pagamentos ou configuração de terminais. Retorna data e pagination; siga pagination.next mantendo os filtros. A V1 permanece disponível com seu contrato anterior.

Mesas2 métodos

getListar mesasExige autorização OAuth pessoal de garçom. A loja vem da concessão; não envie restaurante, identidade alternativa ou corpo. Retorna apenas campos públicos aprovados, sem dados pessoais dos clientes, observações livres, chaves de sessão, dados de pagamentos ou configuração de terminais.getListar mesas (V2 paginada)Exige autorização OAuth pessoal de garçom. A loja vem da concessão; não envie restaurante, identidade alternativa ou corpo. Retorna apenas campos públicos aprovados, sem dados pessoais dos clientes, observações livres, chaves de sessão, dados de pagamentos ou configuração de terminais. Retorna data e pagination; siga pagination.next mantendo os filtros. A V1 permanece disponível com seu contrato anterior.

Comandas3 métodos

getListar comandas ativasExige autorização OAuth pessoal de garçom. A loja vem da concessão; não envie restaurante, identidade alternativa ou corpo. Retorna apenas campos públicos aprovados, sem dados pessoais dos clientes, observações livres, chaves de sessão, dados de pagamentos ou configuração de terminais. Limitado ao atendimento presencial ativo na loja; não é um histórico de vendas.getListar comandas ativas (V2 paginada)Exige autorização OAuth pessoal de garçom. A loja vem da concessão; não envie restaurante, identidade alternativa ou corpo. Retorna apenas campos públicos aprovados, sem dados pessoais dos clientes, observações livres, chaves de sessão, dados de pagamentos ou configuração de terminais. Limitado ao atendimento presencial ativo na loja; não é um histórico de vendas. Retorna data e pagination; siga pagination.next mantendo os filtros. A V1 permanece disponível com seu contrato anterior.getConsultar comanda ativaExige autorização OAuth pessoal de garçom. A loja vem da concessão; não envie restaurante, identidade alternativa ou corpo. Retorna apenas campos públicos aprovados, sem dados pessoais dos clientes, observações livres, chaves de sessão, dados de pagamentos ou configuração de terminais. Limitado ao atendimento presencial ativo na loja; não é um histórico de vendas.

Pedidos3 métodos

getListar pedidos ativosExige autorização OAuth pessoal de garçom. A loja vem da concessão; não envie restaurante, identidade alternativa ou corpo. Retorna apenas campos públicos aprovados, sem dados pessoais dos clientes, observações livres, chaves de sessão, dados de pagamentos ou configuração de terminais. Limitado ao atendimento presencial ativo na loja; não é um histórico de vendas. A lista considera os pedidos das últimas 48 horas que continuam ativos.getListar pedidos ativos (V2 paginada)Exige autorização OAuth pessoal de garçom. A loja vem da concessão; não envie restaurante, identidade alternativa ou corpo. Retorna apenas campos públicos aprovados, sem dados pessoais dos clientes, observações livres, chaves de sessão, dados de pagamentos ou configuração de terminais. Limitado ao atendimento presencial ativo na loja; não é um histórico de vendas. A lista considera os pedidos das últimas 48 horas que continuam ativos. Retorna data e pagination; siga pagination.next mantendo os filtros. A V1 permanece disponível com seu contrato anterior.getConsultar itens de um pedidoExige autorização OAuth pessoal de garçom. A loja vem da concessão; não envie restaurante, identidade alternativa ou corpo. Retorna apenas campos públicos aprovados, sem dados pessoais dos clientes, observações livres, chaves de sessão, dados de pagamentos ou configuração de terminais. Limitado ao atendimento presencial ativo na loja; não é um histórico de vendas.

Restaurante

Garçom

On this page