Yourviews

Introdução

Permite buscar avaliações de produto de acordo com critérios informados.

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
}

As chamadas aceitam parâmetros de paginação:

- page 

- count

IMPORTANTE: Você também pode verificar essa documentação com exemplos em nossa coleção do Postman:

https://documenter.getpostman.com/view/3359543/RVu8gSWM#4848b0fa-72f6-1baa-7e00-94b2d589eec7

Estrutura de retorno

Exemplo de retorno

{
    "HasErrors": false,
    "Element": [
        {
            "ReviewId": 229641,
            "Rating": 3,
            "Review": "A co não é igual a da foto. Fora isso, é uma boa camisa.",
            "Date": "2016-06-09T11:10:16",
            "User": {
                "YourviewsUserId": 0,
                "Name": "Hiago Lopes",
                "Email": "hiago@yourviews.com.br"             
            },
            "Product": {
                "YourviewsProductId": 0,
                "ProductId": "7935251",
                "Name": "Camisa Rock CasualT-Shirt",
                "Url": "http://temporario-nova-loja-hzuzx.lojaintegrada.com.br/camisa-rock-casual?yv-debug=true&yv-cache=true",
                "Image": "https://cdn.awsli.com.br/600x450/268/268174/produto/7935251/78bda00e07.jpg"              
            },
            "Likes": 1,
            "Dislikes": 0,
            "CustomFields": [
                {
                    "Name": "Caimento",
                    "Values": [
                        "Bom"
                    ]
                },
                {
                    "Name": "Qualidade do tecido",
                    "Values": [
                        "Médio"
                    ]
                },
                {
                    "Name": "Tamanho",
                    "Values": [
                        "P"
                    ]
                },
                {
                    "Name": "Sexo",
                    "Values": [
                        "Masculino"
                    ]
                },
                {
                    "Name": "Uso do produto",
                    "Values": [
                        "dia a dia"
                    ]
                },
                {
                    "Name": "Você recomenda esse produto a um amigo?",
                    "Values": [
                        "Sim"
                    ]
                }
            ]
        }
    ],
    "ErrorList": [],
    "Total": 60,
    "CurrentPage": 1
}

Buscar todos os reviews

Endpoint: GET /review/

Busca todos os reviewsda base. Lembre-se de utilizar a paginação para navegar pelos resultados.

Buscar review por id

Endpoint: GET /review/ID_DO_REVIEW

Busca um único review, de acordo com seu ID

Buscar review por id do produto

Endpoint: GET /review/?productId=ID_DO_PRODUTO

Busca todos os reviews de um produto. O ID do produto é aquele utilizado pela loja virtual

É possível ordenar os resultados informando o parâmetro "orderBy" na URL, como abaixo:

GET /review/?productId=ID_DO_PRODUTO&orderBy=1

Os possíveis valores são:

Buscar review por data

Endpoint: GET /review/?dateFrom=yyyy-MM-ddThh:mm:ss

Busca todos os reviews a partir de uma determinada data. É útil para manter sincronizada uma base externa.