API legada/Referência completa/Avaliações e comentários

Endpoints de Discussions

Todas as URLs da API de Discussions com os métodos aceitos, os parâmetros de caminho e os exemplos de avaliação e comentário.

Esta página lista todas as URLs da API de Discussions e os métodos que cada uma aceita. A referência informa a URL base https://www.venddor.com.br/api/2.0, então no seu código a primeira URL abaixo é $BASE_URL/api/2.0/discussions. Use a página para saber qual URL chamar antes de ler os exemplos.

Todas as discussões

Uma única URL, /discussions/, obtém todas as avaliações e comentários ou cria um novo item de discussão.

Método	Descrição	Uso
GET	Obtém todas as discussões	Use os parâmetros de paginação para limitar o resultado. Veja Paginação e filtros.
POST	Cria uma nova discussão	Exige um corpo JSON com os dados da discussão.

GET/api/2.0/discussionsAdmin

Obter todas as avaliações e comentários

Parâmetros de consulta

typestring

reviewcomment

Filtra as discussões por tipo.

pageintegerpadrão: 1

Número da página. A página de filtros traz todos os parâmetros.

items_per_pageintegerpadrão: 10

Quantidade de entradas por página.

POST/api/2.0/discussionsAdmin

Criar uma nova discussão (avaliação ou comentário)

Campos obrigatórios: object_type + object_id, ou thread_id.

Campos disponíveis: object_type, object_id, thread_id, name, message, rating_value, timestamp, status.

Uma discussão específica

A URL /discussions/:id trabalha com uma avaliação ou comentário, identificado pelo id.

Método	Descrição	Uso
GET	Obtém uma discussão específica	Devolve as informações detalhadas da discussão indicada
PUT	Atualiza uma discussão	Exige um corpo JSON com os campos a alterar
DELETE	Exclui uma discussão	Remove a discussão do sistema de forma permanente

GET/api/2.0/discussions/{id}Admin

Obter uma discussão específica

Parâmetros de caminho

idintegerobrigatório

O identificador único da discussão.

PUT/api/2.0/discussions/{id}Admin

Atualizar uma discussão

Parâmetros de caminho

idintegerobrigatório

O identificador único da discussão.

Campos disponíveis: name, message, rating_value, timestamp, status.

DELETE/api/2.0/discussions/{id}Admin

Excluir uma discussão

Parâmetros de caminho

idintegerobrigatório

O identificador único da discussão.

Discussões de um produto

A URL /products/:p_id/discussions/ obtém todas as discussões ligadas a um produto, ou cria uma nova para ele.

Método	Descrição	Uso
GET	Obtém todas as discussões de um produto	Devolve todas as avaliações e comentários do produto indicado
POST	Cria uma nova discussão para um produto	Exige um corpo JSON com os dados da discussão

GET/api/2.0/products/{p_id}/discussionsAdmin

Obter todas as discussões de um produto

Parâmetros de caminho

p_idintegerobrigatório

O identificador único do produto.

Devolve todas as avaliações e comentários do produto indicado.

POST/api/2.0/products/{p_id}/discussionsAdmin

Criar uma nova discussão para um produto

Parâmetros de caminho

p_idintegerobrigatório

O identificador único do produto.

Exige um corpo JSON com os dados da discussão. A referência mostra um exemplo de avaliação e um de comentário, abaixo.

A referência mostra um exemplo de avaliação e um de comentário para essa chamada.

Exemplo de avaliação

json

{
  "type": "review",
  "product_id": 123,
  "user_id": 456,
  "name": "Maria Santos",
  "rating": 4.5,
  "title": "Great product with minor issues",
  "comment": "I've been using this product for three months and I'm very satisfied. It met most of my expectations but there are a few features that could be improved.",
  "reply_to": null,
  "status": "approved"
}

Exemplo de comentário

json

{
  "type": "comment",
  "product_id": 123,
  "user_id": 789,
  "name": "Pedro Oliveira",
  "comment": "I have a question about this product. Does it work with international voltage?",
  "reply_to": null,
  "status": "pending"
}

Uma discussão específica de um produto

A URL /products/:p_id/discussions/:id trabalha com uma discussão ligada a um produto em particular.

Método	Descrição	Uso
GET	Obtém uma discussão específica de um produto	Devolve as informações detalhadas da discussão indicada
PUT	Atualiza uma discussão de um produto	Exige um corpo JSON com os campos a alterar
DELETE	Exclui uma discussão de um produto	Remove a discussão do sistema de forma permanente

GET/api/2.0/products/{p_id}/discussions/{id}Admin

Obter uma discussão específica de um produto

Parâmetros de caminho

p_idintegerobrigatório

O identificador único do produto.

idintegerobrigatório

O identificador único da discussão.

Devolve as informações detalhadas da discussão indicada.

PUT/api/2.0/products/{p_id}/discussions/{id}Admin

Atualizar uma discussão de um produto

Parâmetros de caminho

p_idintegerobrigatório

O identificador único do produto.

idintegerobrigatório

O identificador único da discussão.

Exige um corpo JSON com os campos a alterar.

DELETE/api/2.0/products/{p_id}/discussions/{id}Admin

Excluir uma discussão de um produto

Parâmetros de caminho

p_idintegerobrigatório

O identificador único do produto.

idintegerobrigatório

O identificador único da discussão.

Remove a discussão do sistema de forma permanente.

Tipos de discussão

A API de Discussions aceita dois tipos de entrada.

Tipo	Descrição
`review`	Uma avaliação de produto, que inclui uma nota e normalmente um comentário detalhado
`comment`	Um comentário ou dúvida geral sobre um produto, ou a resposta a outro comentário ou avaliação

API legada/Referência completa/Avaliações e comentários

Endpoints de Discussions

Todas as URLs da API de Discussions com os métodos aceitos, os parâmetros de caminho e os exemplos de avaliação e comentário.

Todas as discussões

Uma única URL, /discussions/, obtém todas as avaliações e comentários ou cria um novo item de discussão.

Método	Descrição	Uso
GET	Obtém todas as discussões	Use os parâmetros de paginação para limitar o resultado. Veja Paginação e filtros.
POST	Cria uma nova discussão	Exige um corpo JSON com os dados da discussão.

GET/api/2.0/discussionsAdmin

Obter todas as avaliações e comentários

Parâmetros de consulta

typestring

reviewcomment

Filtra as discussões por tipo.

pageintegerpadrão: 1

Número da página. A página de filtros traz todos os parâmetros.

items_per_pageintegerpadrão: 10

Quantidade de entradas por página.

POST/api/2.0/discussionsAdmin

Criar uma nova discussão (avaliação ou comentário)

Campos obrigatórios: object_type + object_id, ou thread_id.

Campos disponíveis: object_type, object_id, thread_id, name, message, rating_value, timestamp, status.

Uma discussão específica

A URL /discussions/:id trabalha com uma avaliação ou comentário, identificado pelo id.

Método	Descrição	Uso
GET	Obtém uma discussão específica	Devolve as informações detalhadas da discussão indicada
PUT	Atualiza uma discussão	Exige um corpo JSON com os campos a alterar
DELETE	Exclui uma discussão	Remove a discussão do sistema de forma permanente

GET/api/2.0/discussions/{id}Admin

Obter uma discussão específica

Parâmetros de caminho

idintegerobrigatório

O identificador único da discussão.

PUT/api/2.0/discussions/{id}Admin

Atualizar uma discussão

Parâmetros de caminho

idintegerobrigatório

O identificador único da discussão.

Campos disponíveis: name, message, rating_value, timestamp, status.

DELETE/api/2.0/discussions/{id}Admin

Excluir uma discussão

Parâmetros de caminho

idintegerobrigatório

O identificador único da discussão.

Discussões de um produto

A URL /products/:p_id/discussions/ obtém todas as discussões ligadas a um produto, ou cria uma nova para ele.

Método	Descrição	Uso
GET	Obtém todas as discussões de um produto	Devolve todas as avaliações e comentários do produto indicado
POST	Cria uma nova discussão para um produto	Exige um corpo JSON com os dados da discussão

GET/api/2.0/products/{p_id}/discussionsAdmin

Obter todas as discussões de um produto

Parâmetros de caminho

p_idintegerobrigatório

O identificador único do produto.

Devolve todas as avaliações e comentários do produto indicado.

POST/api/2.0/products/{p_id}/discussionsAdmin

Criar uma nova discussão para um produto

Parâmetros de caminho

p_idintegerobrigatório

O identificador único do produto.

Exige um corpo JSON com os dados da discussão. A referência mostra um exemplo de avaliação e um de comentário, abaixo.

A referência mostra um exemplo de avaliação e um de comentário para essa chamada.

Exemplo de avaliação

json

{
  "type": "review",
  "product_id": 123,
  "user_id": 456,
  "name": "Maria Santos",
  "rating": 4.5,
  "title": "Great product with minor issues",
  "comment": "I've been using this product for three months and I'm very satisfied. It met most of my expectations but there are a few features that could be improved.",
  "reply_to": null,
  "status": "approved"
}

Exemplo de comentário

json

{
  "type": "comment",
  "product_id": 123,
  "user_id": 789,
  "name": "Pedro Oliveira",
  "comment": "I have a question about this product. Does it work with international voltage?",
  "reply_to": null,
  "status": "pending"
}

Uma discussão específica de um produto

A URL /products/:p_id/discussions/:id trabalha com uma discussão ligada a um produto em particular.

Método	Descrição	Uso
GET	Obtém uma discussão específica de um produto	Devolve as informações detalhadas da discussão indicada
PUT	Atualiza uma discussão de um produto	Exige um corpo JSON com os campos a alterar
DELETE	Exclui uma discussão de um produto	Remove a discussão do sistema de forma permanente

GET/api/2.0/products/{p_id}/discussions/{id}Admin

Obter uma discussão específica de um produto

Parâmetros de caminho

p_idintegerobrigatório

O identificador único do produto.

idintegerobrigatório

O identificador único da discussão.

Devolve as informações detalhadas da discussão indicada.

PUT/api/2.0/products/{p_id}/discussions/{id}Admin

Atualizar uma discussão de um produto

Parâmetros de caminho

p_idintegerobrigatório

O identificador único do produto.

idintegerobrigatório

O identificador único da discussão.

Exige um corpo JSON com os campos a alterar.

DELETE/api/2.0/products/{p_id}/discussions/{id}Admin

Excluir uma discussão de um produto

Parâmetros de caminho

p_idintegerobrigatório

O identificador único do produto.

idintegerobrigatório

O identificador único da discussão.

Remove a discussão do sistema de forma permanente.

Tipos de discussão

A API de Discussions aceita dois tipos de entrada.

Tipo	Descrição
`review`	Uma avaliação de produto, que inclui uma nota e normalmente um comentário detalhado
`comment`	Um comentário ou dúvida geral sobre um produto, ou a resposta a outro comentário ou avaliação