/Reviews

Esse recurso gerencia as avaliações dos consumidores feitas após a entrega de um pedido.

Média de avaliações

GET /v1/merchant/reviews/rating

200

{
    "rate": "4.59",
    "rateDelivery": "4.75",
    "rateCost": "4.56",
    "rateProduct": "4.41",
    "ratePackage": "4.79",
    "quantityReviews": "4033",
    "object": "Rating"
}

Listagem de avaliações

GET /v1/merchant/reviews

Método retorna uma listagem de avaliações.

Query Parameters

Name	Type	Description
page[]	string
filter[]	string
sort[]	string

200

{
    "items": [
        {
            "id": "67526",
            "merchantId": "702",
            "customerId": "1",
            "orderId": "366269",
            "rating": "5",
            "ratingDelivery": "5",
            "ratingCost": "5",
            "ratingProduct": "5",
            "ratingPackage": "5",
            "comment": "",
            "isReplied": true,
            "reply": {
                "comment": "Simplesmente maravilhoso, parabéns!",
                "replyAt": "2019-10-27 21:03:05",
                "isPublished": false,
                "object": "Reply"
            },
            "createdAt": "2018-06-27 13:03:52",
            "isPublished": true,
            "object": "Review"
        }
    ],
    "meta": {
        "page": {
            "total": 1,
            "currentPage": 0,
            "lastPage": 0,
            "perPage": 10
        }
    },
    "links": []
}

Informações de uma avaliação

GET /v1/merchant/reviews/:id

Path Parameters

Name	Type	Description
id	string	Identificador numérico da avaliação

200

{
    "id": "67526",
    "merchantId": "702",
    "customerId": "1",
    "orderId": "366269",
    "rating": "5",
    "ratingDelivery": "5",
    "ratingCost": "5",
    "ratingProduct": "5",
    "ratingPackage": "5",
    "comment": "",
    "isReplied": true,
    "reply": {
        "comment": "Simplesmente maravilhoso, parabéns!",
        "replyAt": "2019-10-27 16:52:00",
        "isPublished": false,
        "object": "Reply"
    },
    "createdAt": "2018-06-27 13:03:52",
    "isPublished": true,
    "object": "Review"
}

Responder uma avaliação

POST /v1/merchant/reviews/:id/reply

Path Parameters

Name	Type	Description
id	string	Identificador numérico da avaliação

Request Body

Name	Type	Description
comment	string	Texto de resposta. Não é publicado automaticamente por passar por moderação.

200

{
    "success": true
}

400

{
    "errors": [
        {
            "status": 400,
            "title": "Essa avaliação já contém uma resposta",
            "code": 0
        }
    ]
}