Introdução

Permite buscar a nota média e o total de avaliação de vários produtos de uma vez.

O resultado é no seguinte formato:

{
    "HasErrors": false, //Se houve algum erro na chamada
    "Element": [], //Elementos retornados pela chamada (vide abaixo Estrutura de retorno)
    "ErrorList": [], //Lista de erros, se houver
    "Total": 0, //Total de itens retornados pela busca
    "CurrentPage": 0 //Pagina atual buscada
}

Obs: Saiba mais sobre autenticação e primeiros passos: https://yourviews.freshdesk.com/solution/articles/5000734890-api-basic-auth-primeiros-passos-e-autenticacão


Estrutura de retorno

ReviewShelf    
Estrutura principal de retorno, array de resultados
ProductId
(string) Id do produto. O mesmo informado na chamada do serviço.
TotalRatings
(int) Total de avaliações que o produto possui.
Rating
(double) Nota média do produto. Formato: n.nn. Exemplo: 4.5.


Exemplo de chamada

GET: https://service.yourviews.com.br/api/CODIGO_DA_LOJA/review/reviewshelf?productIds=963,510,1526,536,10

HEADERS: Authorization Basic XXXXXXX


Exemplo de retorno

{
    "HasErrors": false,
    "Element": [
        {
            "ProductId": "1526",
            "TotalRatings": 1,
            "Rating": 4
        },
        {
            "ProductId": "963",
            "TotalRatings": 5,
            "Rating": 5
        },
        {
            "ProductId": "536",
            "TotalRatings": 2,
            "Rating": 3.5
        },
        {
            "ProductId": "510",
            "TotalRatings": 5,
            "Rating": 5
        },
        {
            "ProductId": "10",
            "TotalRatings": 0,
            "Rating": 0
        }
    ],
    "ErrorList": [],
    "Total": 0,
    "CurrentPage": 0


Buscar notas de vários produtos

Endpoint: GET /reviewshelf?productIds=123,456

Busca as notas médias dos produtos "123" e "456". 

IMPORTANTE: Caso algum dos produtos não tenha reviews, eles serão retornados com resultados zerados.