VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Configurações do seller

Reputação do seller

Lê o termômetro de reputação de um seller, esconde ou mostra o termômetro na vitrine e pede o recálculo.

A reputação é uma nota de 0 a 100 que resume a qualidade do atendimento do seller nos últimos 60 dias (cancelamentos, atrasos no despacho, devoluções e avaliações). A vitrine a mostra como um termômetro colorido. A nota é calculada pela plataforma: o administrador não a edita, só a lê, esconde ou manda recalcular. Qualquer administrador autenticado acessa estas três rotas.

Faixa (band)NotaSignificado
green80 a 100Reputação boa.
yellow50 a 79Atenção.
red0 a 49Reputação ruim.
neutralsem notaSeller novo (menos de 10 pedidos entregues no período) ou termômetro escondido.

Ler a reputação

GET/api/v1/admin/vendors/{id}/reputationAdmin

Lê a reputação de um seller

Parâmetros de caminho

iduuidobrigatório
Id do seller.
200Reputação
json
{
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "score": 71,
  "band": "yellow",
  "hidden": false,
  "cold_start": false,
  "top_issues": ["cancellation_rate"],
  "orders_in_window": 3237
}

Campos da resposta

scoreinteger
Nota de 0 a 100. Vem 0 quando o termômetro está escondido. Em seller novo (cold_start), a faixa é neutral e a nota não deve ser usada.
bandstring
greenyellowredneutral
Faixa do termômetro.
hiddenboolean
true quando o administrador escondeu o termômetro.
cold_startboolean
true com menos de 10 pedidos entregues nos últimos 60 dias.
top_issuesarray
Até 3 indicadores que passaram do limite aceitável, na ordem fixa cancellation_rate (cancelamentos acima de 2%), late_dispatch_rate (despachos atrasados acima de 5%), return_rate (devoluções acima de 3%) e rating_avg (média de avaliações abaixo de 4,0). Códigos em inglês.
orders_in_windowinteger
Pedidos entregues considerados nos últimos 60 dias.

Esconder ou mostrar o termômetro

Não muda a nota; só decide se a vitrine mostra o termômetro.

PUT/api/v1/admin/vendors/{id}/reputation/visibilityAdmin

Esconde ou mostra o termômetro do seller

Parâmetros de caminho

iduuidobrigatório
Id do seller.

Corpo da requisição

hiddenbooleanobrigatório
true esconde o termômetro; false mostra.
200Atualizado
json
{ "hidden": true }

A rota não confere se o seller existe: um UUID sem seller também responde 200.

Recalcular

Recalcula a nota agora, grava o resultado e devolve a reputação nova. A plataforma já recalcula periodicamente; use esta rota depois de corrigir um problema que pesa na nota.

POST/api/v1/admin/vendors/{id}/reputation/recomputeAdmin

Recalcula a reputação de um seller

Parâmetros de caminho

iduuidobrigatório
Id do seller.

A resposta (200) tem o mesmo formato da leitura.

Defeito conhecido: o recálculo responde 500

Na verificação feita para este manual, POST .../recompute respondeu 500 {"error":"failed to recompute"} para um seller real. O recálculo periódico da plataforma continua valendo, e a leitura funciona. Enquanto o defeito existir, não dá para forçar o recálculo por esta rota.

Erros

StatusQuandoCorpo de exemplo
400Corpo do PUT não é JSON.{"error":"invalid request body","detail":"..."}
404GET de seller que não existe.{"error":"vendor not found","detail":"..."}
500Falha no recálculo (defeito acima).{"error":"failed to recompute","detail":"..."}
401Sem token.{"error":"missing authorization header"}
Escondido muda também o que você lê

Com hidden: true, esta própria leitura devolve band: "neutral" e score: 0. Para ver a nota real, mostre o termômetro de novo (hidden: false) antes de consultar.

Veja também

  • Visibilidade do seller
  • Visão geral
Anterior
Férias do seller
Próxima
Vitrine própria do seller
Nesta página
  • Ler a reputação
  • Esconder ou mostrar o termômetro
  • Recalcular
  • Erros
  • Veja também