This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
The following operations for creating, retrieving and deleting reviews are available:
/categories/{categoriesKey}/products/{productKey}/reviews
This operation submits a user review for a product.
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource.addReview(com.intershop.sellside.rest.common.capi.resourceobject.NewReviewRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | categoriesKey | string | 153 | Required | The category ID | |
in path | productKey | string | 10809311 | Required | The product SKU |
201 - Created - The review was successfully created.
400 - Bad Request - At least one attribute is missing or invalid.
401 - Unauthorized - The user could not be authenticated.
404 - Not Found - The product could not be found.
422 - Unprocessable Entity - The customer already created a review for this product.
/categories/{categoriesKey}/products/{productKey}/reviews/{ReviewKey}
This operation deletes a specific user review of a specific product.
public void com.intershop.sellside.rest.common.capi.resource.review.ReviewItemResource.deleteProductReviewByID()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | categoriesKey | string | 153 | Required | The category ID | |
in path | productKey | string | 10809311 | Required | The product SKU | |
in path | ReviewKey | string | aUAKDgAFMa8AAAF2XvNMKHUM | Required | The review ID |
204 - No Content - The review was successfully deleted.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The supplied user is not allowed to delete this review.
404 - Not Found - The product or review could not be found.
/categories/{categoriesKey}/products{spgid}/{productKey}/reviews
This operation returns a list of all user reviews for a product.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource.getProductReviews(java.lang.String,java.lang.Boolean,java.lang.Boolean)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | spgid | string | FUOGrzQ_VjORpGaN8DRGmLLE0000 | The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID> . Required if you want to work with customer-specific content. | |
in path | categoriesKey | string | 153 | Required | The category ID | |
in path | productKey | string | 10809311 | Required | The product SKU | |
in query | attrs | string | status,rating | attrs can contain the following attribute names separated by comma:- authorname : Name of the author (firstname and lastname, showAuthorNameFlag)- content : Content of the review- creationdate : Creation date of the review- rating : Rating of the review (0..5)- status : Status of the review (NEW, APPROVED)- title : Title of the review- localeid : Locale id of the review- own : Flag if the review is owned by the requested user | |
in query | own | boolean | false | Flag that determines if the review list should contain only reviews owned by the requested user or only reviews from other authors. If the flag is omitted, all reviews are returned. | |
in query | localespecific | boolean | false | false | Flag that determines if the review list should contain reviews for the requested locale or all reviews independent from the requested locale. |
200 - OK - The reviews for the given product.
401 - Unauthorized - The user could not be authenticated.
404 - Not Found - The product could not be found.
/categories/{categoriesKey}/products{spgid}/{productKey}/reviews/{ReviewKey}
This operation returns a specific user review of a specific product.
public com.intershop.sellside.rest.common.capi.resourceobject.ReviewRO com.intershop.sellside.rest.common.capi.resource.review.ReviewItemResource.getProductReviewByID()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | spgid | string | FUOGrzQ_VjORpGaN8DRGmLLE0000 | The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID> . Required if you want to work with customer-specific content. | |
in path | categoriesKey | string | 153 | Required | The category ID | |
in path | productKey | string | 10809311 | Required | The product SKU | |
in path | ReviewKey | string | aUAKDgAFMa8AAAF2XvNMKHUM | Required | The review ID |
200 - OK - The review with the given ID.
401 - Unauthorized - The user could not be authenticated.
404 - Not Found - The product or review could not be found.
/products/{productKey}/reviews
This operation submits a user review for a product.
public com.intershop.component.rest.capi.resourceobject.LinkRO com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource.addReview(com.intershop.sellside.rest.common.capi.resourceobject.NewReviewRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | productKey | string | 10809311 | Required | The product SKU |
201 - Created - The review was successfully created.
400 - Bad Request - At least one attribute is missing or invalid.
401 - Unauthorized - The user could not be authenticated.
404 - Not Found - The product could not be found.
422 - Unprocessable Entity - The customer already created a review for this product.
/products/{productKey}/reviews/{ReviewKey}
This operation deletes a specific user review of a specific product.
public void com.intershop.sellside.rest.common.capi.resource.review.ReviewItemResource.deleteProductReviewByID()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | productKey | string | 10809311 | Required | The product SKU | |
in path | ReviewKey | string | aUAKDgAFMa8AAAF2XvNMKHUM | Required | The review ID |
204 - No Content - The review was successfully deleted.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The supplied user is not allowed to delete this review.
404 - Not Found - The product or review could not be found.
/products{spgid}/{productKey}/reviews
This operation returns a list of all user reviews for a product.
public com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO com.intershop.sellside.rest.common.capi.resource.review.ReviewListResource.getProductReviews(java.lang.String,java.lang.Boolean,java.lang.Boolean)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | spgid | string | FUOGrzQ_VjORpGaN8DRGmLLE0000 | The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID> . Required if you want to work with customer-specific content. | |
in path | productKey | string | 10809311 | Required | The product SKU | |
in query | attrs | string | status,rating | attrs can contain the following attribute names separated by comma:- authorname : Name of the author (firstname and lastname, showAuthorNameFlag)- content : Content of the review- creationdate : Creation date of the review- rating : Rating of the review (0..5)- status : Status of the review (NEW, APPROVED)- title : Title of the review- localeid : Locale id of the review- own : Flag if the review is owned by the requested user | |
in query | own | boolean | false | Flag that determines if the review list should contain only reviews owned by the requested user or only reviews from other authors. If the flag is omitted, all reviews are returned. | |
in query | localespecific | boolean | false | false | Flag that determines if the review list should contain reviews for the requested locale or all reviews independent from the requested locale. |
200 - OK - The reviews for the given product.
401 - Unauthorized - The user could not be authenticated.
404 - Not Found - The product could not be found.
/products{spgid}/{productKey}/reviews/{ReviewKey}
This operation returns a specific user review of a specific product.
public com.intershop.sellside.rest.common.capi.resourceobject.ReviewRO com.intershop.sellside.rest.common.capi.resource.review.ReviewItemResource.getProductReviewByID()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | spgid | string | FUOGrzQ_VjORpGaN8DRGmLLE0000 | The secure personalization group identifier, submitted as matrix parameter ;spgid=<PGID> . Required if you want to work with customer-specific content. | |
in path | productKey | string | 10809311 | Required | The product SKU | |
in path | ReviewKey | string | aUAKDgAFMa8AAAF2XvNMKHUM | Required | The review ID |
200 - OK - The review with the given ID.
401 - Unauthorized - The user could not be authenticated.
404 - Not Found - The product or review could not be found.
Link
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
int32
int32
int32
LinkRO
objects. The list of elementsLinkRO
: A Link pointing to a resourceLink
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
string
literals. The keys to sort forNewReview
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
Good choice
I am satisfied with my purchase. The quality is very good for the price. I still wish there were more features.
int32
| Example: 5
true
ResourceAttribute
object. An attributeResourceAttribute
Review
ResourceAttribute
objects. The list of attributesResourceAttribute
: An attributeResourceAttribute
Alexandra
Heimroth
Good choice
I am satisfied with my purchase. The quality is very good for the price. I still wish there were more features.
y60KDACwgR8AAAFB0MKGQOQj
date-time
int32
| Example: 5
NEW (NOT APPROVED)
[NEW, APPROVED, REJECTED]
true
en_US
false
ResourceAttribute
object. An attributeResourceAttribute