title | description | last_updated | template | originalLink | originalArticleId | redirect_from | related | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Glue API: Manage product reviews |
Learn how to manage product reviews via Glue API. |
Jun 16, 2021 |
glue-api-storefront-guide-template |
e712d25f-b084-4fac-ac5f-cbb46e0947cb |
|
|
Ratings and reviews allow customers to share their opinions and experiences about purchases. This enables customers to take meaningful decisions about purchases and increases their trust with the shop.
Products and ratings API helps you to:
- Retrieve average rating of any product.
- Retrieve a list of ratings and reviews of a product.
- Allow customers to review and rate products.
For detailed information on the modules that provide the API functionality and related installation instructions, see Install the Product Rating and Reviews Glue API
To retrieve product reviews, send the request:
GET
/abstract-products/{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %}/product-reviews
PATH PARAMETER | DESCRIPTION |
---|---|
{% raw %}{{{% endraw %}abstract_product_sku{% raw %}}}{% endraw %} | Unique identifier of a product to retrieve product reviews for. |
STRING PARAMETER | DESCRIPTION | POSSIBLE VALUES |
---|---|---|
page[offset] | Offset of the item at which to begin the response. | From 0 to any. |
page[limit] | Maximum number of entries to return. | From 1 to any. |
Request sample: retrieve product ratings and reviews: GET http://glue.mysprykershop.com/abstract-products/035/product-reviews
Response sample: retrieve product reviews
{
"data": [
{
"type": "product-reviews",
"id": "40",
"attributes": {
"rating": 3,
"nickname": "Stephen Grumpy",
"summary": "Not that awesome",
"description": "The specs are good, but the build quality desires to be better."
},
"links": {
"self": "http://glue.mysprykershop.com/product-reviews/40"
}
},
{
"type": "product-reviews",
"id": "42",
"attributes": {
"rating": 5,
"nickname": "John Doe",
"summary": "Excellent product",
"description": "Powerful processor, bright screen and beatiful design - what else do you need?"
},
"links": {
"self": "http://glue.mysprykershop.com/product-reviews/42"
}
}
],
"links": {
"self": "http://glue.mysprykershop.com/abstract-products/139/product-reviews",
"last": "http://glue.mysprykershop.com/abstract-products/139/product-reviews?page[offset]=10&page[limit]=10",
"first": "http://glue.mysprykershop.com/abstract-products/139/product-reviews?page[offset]=0&page[limit]=10",
"next": "http://glue.mysprykershop.com/abstract-products/139/product-reviews?page[offset]=10&page[limit]=10"
}
}
{% include /pbc/all/glue-api-guides/{{page.version}}/product-reviews-response-attributes.md %}
To submit a product review, send the request:
POST
/abstract-products/{% raw %}{{{% endraw %}product_sku{% raw %}}}{% endraw %}/product-reviews
PATH PARAMETER | HEADER |
---|---|
{% raw %}{{{% endraw %}product_sku{% raw %}}}{% endraw %} | Unique identifier of an abstract product to post a rating and review for. |
HEADER KEY | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
Authorization | string | ✓ | Alphanumeric string that authorizes the customer or company user to send requests to protected resources. Get it by authenticating as a customer or authenticating as a company user. |
Request sample: provide a rating and a review of products
POST http://glue.mysprykershop.com/abstract-products/139/product-reviews
{
"data": {
"type": "product-reviews",
"attributes": {
"nickname": "John Doe",
"rating": 5,
"summary": "Excellent product",
"description": "Powerful processor, bright screen, beautiful design and excellent build quality - what else do you need?"
}
}
}
{% include /pbc/all/glue-api-guides/{{page.version}}/product-reviews-response-attributes.md %}
{
"data": {
"type": "product-reviews",
"id": "42",
"attributes": {
"rating": 5,
"nickname": "John Doe",
"summary": "Excellent product",
"description": "Powerful processor, bright screen, beautiful design and excellent build quality - what else do you need?"
},
"links": {
"self": "http://glue.de.suite-nonsplit.local/product-reviews/42"
}
}
}
{% include /pbc/all/glue-api-guides/{{page.version}}/product-reviews-response-attributes.md %}
You can retrieve the average rating of a product as follows:
Also, all the endpoints that accept abstract-products
and concrete-products
resources as included resources in requests, return the average product rating.
CODE | REASON |
---|---|
001 | Access token is invalid. |
002 | Access token is missing. |
301 | Abstract product with the specified ID was not found. |
311 | Abstract product ID is not specified. |
901 | One or more of the following reasons:
|
To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.