Nova API V1.0 · Referência
Listar clientes vinculados ao restaurante
Exige `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.
Exige 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.
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 ou credenciais com uma única loja.
Obrigatório quando uma chave ou autorização OAuth multilojas, ou um
parceiro, cobre várias lojas. É validado contra as lojas atualmente
autorizadas pela credencial. Em uma sessão, um valor diferente do
restaurant_id assinado responde 403.
Cadastro ativo no Clube da loja. Aceita somente true ou false; ausência não filtra.
Response Body
application/json
application/json
application/json
application/json
application/json
Listar avaliações do restaurante GET
OAuth 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.
Listar clientes do Clube de Fidelidade GET
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.