Skip to main content
A API da Repediu tem três famílias de rotas, e quase toda pergunta de negócio se responde combinando duas ou três delas. Esta página é o mapa: como ir de “quero saber X” até a chamada certa, sem tentativa e erro.

​
Tudo começa pelo merchantId

Toda rota de CRM e de métricas trabalha sobre uma loja por vez, identificada pelo merchantId no caminho da URL. Esse identificador é o mesmo id retornado por Listar merchants — que por isso é sempre a primeira chamada de qualquer integração, seja Open Delivery ou CRM do parceiro.
1

Autentique-se uma vez

Gere um token em Obter token e reutilize-o em todas as chamadas até expirar. O mesmo token vale para as três famílias de rotas.
2

Descubra as lojas do seu escopo

Chame Listar merchants e guarde o id de cada estabelecimento. É esse valor que entra como merchantId nas URLs de CRM e métricas.
3

Escolha a rota pela pergunta

Se a pergunta já tem uma métrica pronta, use-a direto. Se precisa de detalhe linha a linha, vá ao dado bruto — as seções abaixo mostram como decidir.
Um merchantId inexistente ou de loja que não ativou a sua integração responde 404 com {"code": "NOT_FOUND", "message": "Merchant not found."} — a API não revela a existência de lojas fora do seu escopo, o mesmo comportamento de Obter merchant.

​
Métrica pronta ou dado bruto?

Antes de buscar dado bruto e calcular por conta própria, verifique se a pergunta já bate com uma das métricas prontas: elas retornam o número calculado pela Repediu, numa única chamada, sem paginação. É mais simples, mais rápido e elimina o risco de o seu cálculo divergir do painel da Repediu. O dado bruto entra em cena quando a pergunta não bate com nenhuma métrica: analisar clientes individualmente, cruzar conversões com avaliações, montar séries temporais próprias, alimentar um data warehouse. Aí você combina as rotas de dado bruto usando os identificadores que elas compartilham.

​
Os elos entre as rotas de dado bruto

Três identificadores costuram as rotas entre si. Pense neles como as chaves de um banco de dados:

campaignId

Nasce em Campanhas e aparece em Conversões e Estatísticas de campanha.

customerId

Nasce em Clientes e aparece em Conversões, Cupons e Avaliações.

saleId

Aparece em Conversões, Cupons e Avaliações — e é o id do pedido no Open Delivery.
  • Análise de campanha: o campaignId de Campanhas identifica a mesma campanha em Conversões (quando a venda veio de uma mensagem de campanha) e em Estatísticas de campanha. Juntando as três, você sabe o que a campanha é, quanto custou por dia e quanto vendeu.
  • Histórico por cliente: o customerId de Clientes identifica o mesmo cliente em Conversões, Cupons e Avaliações. Como os dados de cliente são pseudonimizados (sem nome, telefone ou e-mail), esse é o elo para montar a jornada de um cliente sem expor dado pessoal.
  • Do CRM ao pedido completo: o saleId presente em Conversões, Cupons e Avaliações é o mesmo id retornado por Listar pedidos. Quando precisar dos itens, valores e modalidade de uma venda específica, busque-a em Obter pedido com esse identificador.

​
Exemplo fim a fim: receita de reativação no mês

Pergunta: “quanto as campanhas de reativação trouxeram de receita este mês?”
1

Pegue o merchantId

GET /od/v2/merchants — guarde o id da loja que você quer analisar.
2

Use a métrica pronta

GET /v1/stores/{merchantId}/metrics/recovered-revenue?from=2026-08-01&to=2026-08-31 retorna { "value": ... } — a resposta pronta, em uma chamada.
3

Só se precisar do detalhe por venda

GET /v1/stores/{merchantId}/conversions?from=2026-08-01&to=2026-08-31, ficando com os itens de isReactivation = true. Para ver os itens e valores de cada venda, busque o pedido em GET /od/v2/orders/{orderId} usando o saleId da conversão.
O passo 2 sozinho resolve a maioria dos casos. Desça ao dado bruto apenas quando a pergunta exigir o detalhe — e, quando descer, confira se a soma bate com a métrica pronta: é um bom teste de sanidade da sua integração.