Related Documents
Document Properties
Kbid2447S5
Last Modified23-Jun-2020
Added to KB04-Jun-2013
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Add new product review


Note

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

URI

/products/<sku>/reviews

Http Method

POST

Short Description

Add new product review

Query Parameters

none

Example Requests

/products/1454627/reviews

HTTP Status Codes

201 Created 
400 Bad Request
403 Forbidden
404 Not found (product not found)

Description

The request retrieves the newly created review.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

Product To Version

 

Status

final

JSON

Request Data Format

application/json

Request related java object

com.intershop.sellside.rest.b2c.capi.resource.ReviewResource
com.intershop.sellside.rest.b2c.capi.resourceobject.ReviewRO

Request Example

{ 
	"title":"My Review Title",
	"content":
	"My Review Content", 
	"rating": 2 
}

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.b2c.capi.resource.ReviewResource
com.intershop.component.rest.capi.resourceobject.LinkRO

Response Example

{
    "type": "Link",
    "description": "Review alexandra102 by Alexandra Heimroth",
    "title": "9fwKDACwSZ0AAAFB8C2UWOsQ",
    "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/859910/reviews/9fwKDACwSZ0AAAFB8C2UWOsQ"
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

com.intershop.sellside.rest.b2c.capi.resource.ReviewResource
com.intershop.sellside.rest.b2c.capi.resourceobject.ReviewRO

XML Request Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Review type="Review">
    <content>alexandra120122112</content>
    <rating>5</rating>
    <title>alexandra102</title>
</Review>

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.b2c.capi.resource.ReviewResource
com.intershop.component.rest.capi.resourceobject.LinkRO

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Link type="Link">
    <description>Review alexandra102 by Alexandra Heimroth</description>
    <title>B.4KDACwQlwAAAFBN3aUWOsO</title>
    <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/products/859910/reviews/B.4KDACwQlwAAAFBN3aUWOsO</uri>
</Link>

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