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

Avaliações de produtos

Veja as avaliações dos clientes sobre os produtos do seller, responda publicamente e modere.

Depois de receber um pedido, o cliente pode avaliar cada produto com nota de 1 a 5, título e texto. As avaliações aparecem na página do produto e entram na nota média dele. Estas rotas, em /api/v1/vendor/reviews, mostram ao seller (lojista) as avaliações dos produtos dele, permitem uma resposta pública e, quando permitido, aprovar ou rejeitar.

Pontos principais
  • O módulo product-reviews precisa estar ligado na loja; senão toda rota responde 403 module_disabled.
  • Cada avaliação aceita uma resposta do seller. Responder de novo substitui a anterior.
  • O administrador pode desligar as respostas de seller (review_vendor_replies); nesse caso responder dá 403.
  • Aprovar e rejeitar mudam a nota média do produto. Na versão atual essas duas rotas recusam tokens de seller: veja o aviso na página de moderação.
  • Avaliar é feito pelo cliente, pelo pedido entregue; o seller não cria nem edita avaliações.

Como funciona

statusSignificado
pendingAguardando moderação; não aparece na loja.
approvedPublicada e conta na nota média.
rejectedRecusada pela moderação.
spam, disabled, hiddenOutros estados que o administrador pode aplicar.

Nesta API o status sai em palavras (approved). No filtro de listagem você pode usar palavras ou a letra (A, P, R, S, D, H).

  1. Ver o que chegou

    Listar avaliações, por exemplo reply=unreplied.

  2. Responder

    Responder publica o texto abaixo da avaliação.

Conceitos-chave

Quem é o dono

A avaliação pertence a um produto; o seller enxerga as avaliações dos produtos que são dele. Para aprovar, rejeitar ou responder a uma avaliação de outro seller, a resposta é 403 review is not on your product. A equipe do seller (gerente, membro) é reconhecida nestas rotas.

Dados do cliente

A lista mostra só o nome de exibição do avaliador (reviewer_name). A resposta de aprovar e rejeitar devolve a avaliação completa, incluindo user_id e, em avaliações de visitantes, guest_name e guest_email. Trate-os como dados pessoais.

Endpoints

MétodoCaminhoPara que serveAutenticação
GET/api/v1/vendor/reviewsLista as avaliações dos produtos do seller.vendor
PUT/api/v1/vendor/reviews/{id}/approveAprova uma avaliação.vendor
PUT/api/v1/vendor/reviews/{id}/rejectRejeita uma avaliação.vendor
POST/api/v1/vendor/reviews/{id}/replyPublica ou substitui a resposta do seller.vendor
DELETE/api/v1/vendor/reviews/{id}/replyApaga a resposta do seller.vendor

Erros comuns

  1. Mandar a letra no corpo e palavra no filtro (ou o contrário). O filtro status aceita os dois; a resposta sempre sai em palavra.
  2. Esperar 404 ao apagar uma resposta que não existe. A rota responde 500.
  3. Responder com HTML. As tags são removidas; só o texto fica.
  4. Contar com aprovar/rejeitar pelo token do seller. Na versão atual essas duas rotas respondem 403 admin access required.
  5. Responder com as respostas desligadas. 403 vendor replies are disabled by admin; consulte vendor_replies_allowed na lista.

Próximos passos

Listar e moderar
A fila de avaliações.
Responder
Resposta pública do seller.
Anterior
Leads de um formulário
Próxima
Listar e moderar avaliações
Nesta página
  • Como funciona
  • Conceitos-chave
  • Quem é o dono
  • Dados do cliente
  • Endpoints
  • Erros comuns
  • Próximos passos