Skip to main content
GET
Clientes (CRM)
Retorna a base de clientes de uma loja sob a ótica do CRM: para cada cliente, o perfil de compra calculado pela Repediu — quantas vezes comprou, quanto gastou, ticket médio, intervalo entre compras, melhor dia da semana e status RFV.
Os dados são pseudonimizados: não há nome, telefone nem e-mail. O customerId é o elo para cruzar com Conversões, Cupons e Avaliações sem expor dado pessoal. Se precisar do cadastro do cliente (contatos, endereços), use Obter cliente (CRM).
A paginação é por cursor opaco: repita a chamada passando cursor com o valor de nextCursor da página anterior, até nextCursor vir null. limit padrão 100, máximo 500 (valores maiores são reduzidos para 500 silenciosamente). Para sincronização incremental, use updatedSince — só retorna clientes atualizados a partir daquele instante.
Os campos de opt-in (whatsappOptin, emailOptin) dizem se o cliente aceita comunicação em cada canal — úteis para estimar o alcance de uma campanha antes de criá-la. rfvStatus é o nome do status em português (por exemplo Campeões, Fiéis, Em risco, Promissores, Perdidos) e bestWeekday é o índice numérico do dia da semana em que o cliente mais compra (0 = domingo).

Erros

Obter cliente (CRM)

A ficha completa de um único cliente pelo customerId — incluindo contato e histórico.

Autorizações

Authorization
string
header
obrigatório

Token de acesso emitido por POST /od/v2/oauth/token (fluxo client_credentials). Envie no header Authorization como Bearer <token>.

Parâmetros de caminho

merchantId
string<uuid>
obrigatório

Identificador (UUID) do merchant — o mesmo id de GET /od/v2/merchants.

Parâmetros de consulta

updatedSince
string<date-time>

Retorna apenas clientes atualizados a partir deste instante (sincronização incremental).

cursor
string

Cursor opaco da próxima página, retornado em nextCursor. Omita na primeira chamada.

limit
integer<int32>
padrão:100

Itens por página. Valores acima de 500 são limitados a 500.

Intervalo obrigatório: x <= 500

Resposta

Página de clientes da loja, ordenada por atualização.

items
object[]
nextCursor
string | null

Cursor da próxima página. Null quando não há próxima página.