Avaliações

O objetivo deste endpoint é fornecer dados de avaliações/reviews de usuários sobre produtos.

Listar Avaliações

Get

/web-api/v1/Shopping/Review/Get

Método para listar todas as avaliações.

Parâmetros de entrada

Tipo

Descrição

Limit

Int

Quantidade de registros solicitado.

Offset

Int

Posição inicial da lista retornada (padrão é 0).

Customerid

Int

Opcional: Id do cliente (Se omitido, retornará todos os reviews de todos os clientes).

Sort

String

Opcional: permite definir regras de ordenação. (Ex: sort=ProductReviewID:desc,Status:asc).
Os campos disponíveis para ordenação são:

  • ProductReviewID
  • Name
  • Email
  • Title
  • ReviewBody
  • ReviewDate
  • Status
  • WebSiteID
  • CustomerID

Para paginar os registros, chame a listagem incrementando o campo offset com o valor de limit, veja este exemplo de chamada com javascript:

$.ajax({ 
  url: "<URL_DA_LOJA>/web-api/v1/Shopping/Review/Get?offset=0&limit=10&customerid=1&sort=ProductReviewID:desc,Status:asc", 
  type: 'get', 
  success: function(r) { 
    console.log(r); 
  }
}); //página 1

$.ajax({ 
  url: "<URL_DA_LOJA>/web-api/v1/Shopping/Review/Get?offset=10&limit=10&customerid=1&sort=ProductReviewID:desc,Status:asc", 
  type: 'get', 
  success: function(r) { 
    console.log(r); 
  }
}); //página 2

Response

{
    "Model": [
        {
            "ProductReviewID": 2,
            "Name": "Cliente_2503d8cf-63ec-4def-bb55-9fcf20356247",
            "Email": "[email protected]",
            "Title": "Titulo 2",
            "ReviewBody": "buenacho",
            "ReviewDate": "2018-10-11T15:22:03.947",
            "Status": "A",
            "WebSiteID": 1,
            "ProductID": 52,
            "ProductRating": {
                "ProductRatingID": 2,
                "CustomerID": 1,
                "WebSiteID": 1,
                "RatingDate": "2018-10-11T15:22:03.947",
                "Average": 5
            },
            "CustomerID": 1
        },
        {
            "ProductReviewID": 1,
            "Name": "Cliente_2503d8cf-63ec-4def-bb55-9fcf20356247",
            "Email": "[email protected]",
            "Title": "Titulo 1",
            "ReviewBody": "Muy bueno",
            "ReviewDate": "2018-10-11T15:18:46.17",
            "Status": "A",
            "WebSiteID": 1,
            "ProductID": 52,
            "ProductRating": {
                "ProductRatingID": 1,
                "CustomerID": 1,
                "WebSiteID": 1,
                "RatingDate": "2018-10-11T15:18:46.17",
                "Average": 5
            },
            "CustomerID": 1
        }
    ],
    "Count": 2,
    "IsValid": true,
    "Errors": [],
    "Warnings": [],
    "Custom": {},
    "SuccessMessage": null,
    "UrlCallback": null,
    "ResponseCallBack": {
        "<Code>k__BackingField": "",
        "<Value>k__BackingField": "",
        "<Parameters>k__BackingField": []
    },
    "IntegrationID": null,
    "OperationTimings": []
}

Listar Avaliadores

GetReviewers

/web-api/v1/Shopping/Review/GetReviewers

Método para listar todas os avaliadores.

Parâmetros de entrada

Tipo

Descrição

Limit

Int

Quantidade de registros solicitado.

Offset

Int

Posição inicial da lista retornada (padrão é 0).

Sort

String

Opcional: permite definir regras de ordenação. (Ex: sort=ProductReviewID:desc,Status:asc).
Os campos disponíveis para ordenação são:

  • ProductReviewID
  • Name
  • Email
  • Title
  • ReviewBody
  • ReviewDate
  • Status
  • WebSiteID
  • CustomerID

Para paginar os registros, chame a listagem incrementando o campo offset com o valor de limit, veja este exemplo de chamada com javascript:

$.ajax({ 
  url: "<URL_DA_LOJA>/web-api/v1/Shopping/Review/GetReviewers?offset=0&limit=10&sort=CustomerName:desc,Count:asc", 
  type: 'get', 
  success: function(r) { 
    console.log(r); 
  }
}); //página 1

$.ajax({ 
  url: "<URL_DA_LOJA>/web-api/v1/Shopping/Review/GetReviewers?offset=10&limit=10&sort=CustomerName:desc,Count:asc", 
  type: 'get', 
  success: function(r) { 
    console.log(r); 
  }
}); //página 2

Response

[
  {
    "CustomerID": 1,
    "CustomerName": "Cliente_2503d8cf-63ec-4def-bb55-9fcf20356247",
    "Count": 2
  },
  {
    "CustomerID": 3,
    "CustomerName": "Eduardo",
    "Count": 1
  }
]

Did this page help you?