Related Documents
Document Properties
Kbid2869F6
Last Modified23-Jun-2020
Added to KB22-Aug-2018
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.9
  • ICM 7.10

REST API - Get product reviews


Note

Starting with 7.10 our REST API is documented using Redoc accessible at docs.intershop.com.

URI

/products/<sku>/reviews

Http Method

GET

Short Description

Returns a list of reviews for a product

Query Parameters

none

Example Requests

/products/1454627/reviews

or

/products;spgid=NbaQwWGD1u6RpDkoWPiAHHB60000/1454627/reviews

HTTP Status Codes

200 OK
404 Not found (product not found)

Description

The request retrieves a list of reviews for the indicated product

If the REST call is an authenticated one, spgid parameter should be provided in the request URL as well or the request will be considered anonymous, even if Authorization header is provided. The personalization ID can be retrieved using /personalization call, see: REST API - Get Personalization ID.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.9

Product To Version

 

Status

final

JSON

Request Data Format

application/json

Request related java object

n/a

Request Example

n/a

Response Data Format

application/json

Response related java object

com.intershop.component.rest.capi.resourceobject.LinkRO
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO

Response Example

    "elements": [
        {
            "type": "Link",
            "description": "Review alexandra102 by Alexandra Heimroth",
            "title": "y60KDACwgR8AAAFB0MKGQOQj",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/859910/reviews/y60KDACwgR8AAAFB0MKGQOQj"
        },
        {
            "type": "Link",
            "description": "Review alexandra102 by Alexandra Heimroth",
            "title": "BVEKDACwNZ0AAAFB4IyWYOQS",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/859910/reviews/BVEKDACwNZ0AAAFB4IyWYOQS"
        },
        {
            "type": "Link",
            "description": "Review alexandra105 by Alexandra Heimroth",
            "title": "UeAKDACwTn4AAAFBRQ.TrOQb",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/859910/reviews/UeAKDACwTn4AAAFBRQ.TrOQb"
        },
        {
            "type": "Link",
            "description": "Review alexandra106 by Alexandra Heimroth",
            "title": "mW0KDACwUmIAAAFBVlSGQOQi",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/859910/reviews/mW0KDACwUmIAAAFBVlSGQOQi"
        }
    ],
    "type": "ResourceCollection",
    "name": "reviews"
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

n/a

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.component.rest.capi.resourceobject.LinkRO
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="reviews" type="ResourceCollection">
    <elements>
        <Link type="Link">
            <description>Review alexandra102 by Alexandra Heimroth</description>
            <title>y60KDACwgR8AAAFB0MKGQOQj</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/859910/reviews/y60KDACwgR8AAAFB0MKGQOQj</uri>
        </Link>
        <Link type="Link">
            <description>Review alexandra102 by Alexandra Heimroth</description>
            <title>BVEKDACwNZ0AAAFB4IyWYOQS</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/859910/reviews/BVEKDACwNZ0AAAFB4IyWYOQS</uri>
        </Link>
        <Link type="Link">
            <description>Review alexandra105 by Alexandra Heimroth</description>
            <title>UeAKDACwTn4AAAFBRQ.TrOQb</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/859910/reviews/UeAKDACwTn4AAAFBRQ.TrOQb</uri>
        </Link>
        <Link type="Link">
            <description>Review alexandra106 by Alexandra Heimroth</description>
            <title>mW0KDACwUmIAAAFBVlSGQOQi</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/859910/reviews/mW0KDACwUmIAAAFBVlSGQOQi</uri>
        </Link>
    </elements>
</ResourceCollection>

Reference - WebShop REST APIs

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets