Class ProductReviewsApiV2Controller

{get} /products/:id/reviews/:id Get reviews or average rating for single product

Get multiple, a single review record or the average rating for a single product through the GET method. Use optional lang (e.g.: lang=en) GET-parameter flag to filter based on the provided language code.

400-BadRequest Product ID is missing or invalid.
400-BadRequest Review ID is missing or invalid.
404-NotFound Review record could not be found.

Error-Response (Missing or invalid product ID) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Product record ID was not provided or is invalid." }

Error-Response (Missing or invalid review ID) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Review record ID is invalid." }

Error-Response (Review Not Found) HTTP/1.1 404 Not Found { "code": 404, "status": "error", "message": "Review record could not be found." }

{curl} Get All Review records curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/products/1/reviews

{curl} Get All English Review records curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/products/1/reviews?lang=en

{curl} Get Review record with ID = 982 curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/products/1/reviews/982

{curl} Get Average Rating For Product With ID = 1 curl -i --user admin@shop.de:12345 http://shop.de/api.php/v2/products/1/reviews_avg

Products

GetReviewsForProduct

2.6.0

{post} /products/:id/reviews Create review for single product

This method enables the creation of a new review into the system for the product with the ID that is provided in the request URI. The productId in the request URI will override the productId of the request body.

400-BadRequest Product ID is missing or invalid.
400-BadRequest The body of the request was empty.

Error-Response (Missing or invalid product ID) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Product record ID was not provided or is invalid." }

Error-Response HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Review data were not provided." }

Products

CreateReviewForProduct

{Number} productId The ID of the reviewed product.
{Number} rating The numeric rating value. All integers from 1 to 5 are valid.
{Number} languageId The language ID.
{String} text The review content.
{Object} customer Contains various customer specific information.
{Number} customer.customerId Customer's ID.
{String} customer.customerName Customer's name.

{json} Review entity { "productId": 2, "rating": 5, "languageId": 1, "text": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam", "customer": { "customerId": 3, "customerName": "John Doe" } }

(201) Request-Body If successful, this method returns the complete review resource in the response body.

{json} Success-Response { "id": 3, "productId": 2, "rating": 5, "dateAdded": "2018-01-10 19:10:00", "lastModified": "2018-01-10 19:10:00", "languageId": 1, "text": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam", "customer": { "customerId": 3, "customerName": "John Doe" } }

2.6.0

{put} /products/:id/reviews/:id Update review for single product

Use this method to update an existing review record. Take a look in the POST method for more detailed explanation on every resource property.

400-BadRequest Product ID is missing or invalid.
400-BadRequest Review ID is missing or invalid.
400-BadRequest Review data were not provided.
404-NotFound Review record with provided ID not associated with provided product record ID.

Error-Response (Missing or invalid product ID) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Product record ID was not provided or is invalid." }

Error-Response (Missing or invalid review ID) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Review record ID was not provided or is invalid." }

Error-Response (No data) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Review data were not provided." }

Error-Response (Wrong product-to-review association) HTTP/1.1 404 Not Found { "code": 404, "status": "error", "message": "Provided review record ID ([:reviewId]) is not associated with provided product record ID ([:productId])." }

Products

UpdateReviewForProduct

Response-Body If successful, this method returns the updated withdrawal resource in the response body.

2.6.0

{delete} /products/:1/reviews/:id Delete review

Removes a review record from the system. Assuming that the provided product-to-review association (product ID and review Id in request URI) is correct this method will always return success even if the review does not exist (due to internal ReviewWriteService architecture decisions, which strive to avoid unnecessary failures).

400-BadRequest Product ID is missing or invalid.
400-BadRequest Review ID is missing or invalid.
404-NotFound Review record with provided ID not associated with provided product record ID.

Error-Response (Missing or invalid product ID) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Product record ID was not provided or is invalid." }

Error-Response (Missing or invalid review ID) HTTP/1.1 400 Bad Request { "code": 400, "status": "error", "message": "Review record ID was not provided or is invalid." }

Error-Response (Wrong product-to-review association) HTTP/1.1 404 Not Found { "code": 404, "status": "error", "message": "Provided review record ID ([:reviewId]) is not associated with provided product record ID ([:productId])." }

{curl} Delete review with ID = 84 for product with ID = 23 curl -X DELETE --user admin@shop.de:12345 http://shop.de/api.php/v2/products/23/reviews/84

Products

DeleteReviewForProduct

{json} Success-Response { "code": 200, "status": "success", "action": "delete", "reviewId": 84 }

2.6.0