STORM API
/
Product Service
/
Reviews

Documentation ProductService (1.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://demo.storm.io/api/1.1/

Assortments

Operations

Categories

Operations

Configurations

Operations

Families

Operations

Files

Operations

Filters

Operations

Flags

Operations

InfoTypes

Operations

Manufacturers

Operations

Navigation

Operations

OnHand

Operations

Parametric

Operations

PriceLists

Operations

Products

Operations

Promotions

Operations

Relations

Operations

Reviews

Operations

Insert product review

Request

Inserts a product review and returns the new list. Likes and Dislikes will be set to zero.

Query
cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

Body
required

The actual Review to insert. Likes and Dislikes will be ignored and set to zero.

Idinteger or null(int32)

The internal id of the review. Null or left out when creating new reviews.

ReferenceIdinteger(int32)

The internal product id of the review. Or if the review is for some other entity, then it is the entity Id.

Namestring

The name of the reviewer. MaxLength: 255.

Emailstring

The email address of the reviewer. MaxLength: 255.

Textstring

The review text. MaxLength: max.

Urlstring

A Url to some external source referenced by the reviewer. MaxLength: 255.

ImagePathstring

A Url to some external image uploaded by the reviewer. MaxLength: 255.

Scorenumber(decimal)

The review score, if scores are kept. It is up to the application to define the score range.

Datestring(date-time)

The date of the review.

Likesinteger(int32)

Number of likes. See UpdateProductReviewLikes for information about how to update this.

Dislikesinteger(int32)

Number of dislikes. See UpdateProductReviewLikes for information about how to update this.

IsPublishedboolean or null

Shows if review is published. Applications can have new reviews to not be published and later after internal review on the content have it published.

curl -i -X POST \
  https://demo.storm.io/api/1.1/ProductService.svc/rest/InsertProductReview \
  -H 'Content-Type: application/json' \
  -d '{
    "Id": 0,
    "ReferenceId": 0,
    "Name": "string",
    "Email": "string",
    "Text": "string",
    "Url": "string",
    "ImagePath": "string",
    "Score": 0,
    "Date": "2019-08-24T14:15:22Z",
    "Likes": 0,
    "Dislikes": 0,
    "IsPublished": true
  }'

Responses

Success

Body
Array [
Idinteger or null(int32)

The internal id of the review. Null or left out when creating new reviews.

ReferenceIdinteger(int32)

The internal product id of the review. Or if the review is for some other entity, then it is the entity Id.

Namestring

The name of the reviewer. MaxLength: 255.

Emailstring

The email address of the reviewer. MaxLength: 255.

Textstring

The review text. MaxLength: max.

Urlstring

A Url to some external source referenced by the reviewer. MaxLength: 255.

ImagePathstring

A Url to some external image uploaded by the reviewer. MaxLength: 255.

Scorenumber(decimal)

The review score, if scores are kept. It is up to the application to define the score range.

Datestring(date-time)

The date of the review.

Likesinteger(int32)

Number of likes. See UpdateProductReviewLikes for information about how to update this.

Dislikesinteger(int32)

Number of dislikes. See UpdateProductReviewLikes for information about how to update this.

IsPublishedboolean or null

Shows if review is published. Applications can have new reviews to not be published and later after internal review on the content have it published.

]
Response
[
  {
    "Id": 0,
    "ReferenceId": 0,
    "Name": "string",
    "Email": "string",
    "Text": "string",
    "Url": "string",
    "ImagePath": "string",
    "Score": 0,
    "Date": "2019-08-24T14:15:22Z",
    "Likes": 0,
    "Dislikes": 0,
    "IsPublished": true
  }
]

List product reviews

Request

Lists reviews for a product. Only published Reviews will be listed.

Query
productIdinteger(int32)required

The internal id of the product for which reviews are listed.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductReviews?productId=0'

Responses

Success

Body
Array [
Idinteger or null(int32)

The internal id of the review. Null or left out when creating new reviews.

ReferenceIdinteger(int32)

The internal product id of the review. Or if the review is for some other entity, then it is the entity Id.

Namestring

The name of the reviewer. MaxLength: 255.

Emailstring

The email address of the reviewer. MaxLength: 255.

Textstring

The review text. MaxLength: max.

Urlstring

A Url to some external source referenced by the reviewer. MaxLength: 255.

ImagePathstring

A Url to some external image uploaded by the reviewer. MaxLength: 255.

Scorenumber(decimal)

The review score, if scores are kept. It is up to the application to define the score range.

Datestring(date-time)

The date of the review.

Likesinteger(int32)

Number of likes. See UpdateProductReviewLikes for information about how to update this.

Dislikesinteger(int32)

Number of dislikes. See UpdateProductReviewLikes for information about how to update this.

IsPublishedboolean or null

Shows if review is published. Applications can have new reviews to not be published and later after internal review on the content have it published.

]
Response
[
  {
    "Id": 0,
    "ReferenceId": 0,
    "Name": "string",
    "Email": "string",
    "Text": "string",
    "Url": "string",
    "ImagePath": "string",
    "Score": 0,
    "Date": "2019-08-24T14:15:22Z",
    "Likes": 0,
    "Dislikes": 0,
    "IsPublished": true
  }
]

List all product reviews

Request

Lists all reviews for all products. Only published Reviews will be listed.

Query
cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X GET \
  https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductReviewsAll

Responses

Success

Body
Array [
Idinteger or null(int32)

The internal id of the review. Null or left out when creating new reviews.

ReferenceIdinteger(int32)

The internal product id of the review. Or if the review is for some other entity, then it is the entity Id.

Namestring

The name of the reviewer. MaxLength: 255.

Emailstring

The email address of the reviewer. MaxLength: 255.

Textstring

The review text. MaxLength: max.

Urlstring

A Url to some external source referenced by the reviewer. MaxLength: 255.

ImagePathstring

A Url to some external image uploaded by the reviewer. MaxLength: 255.

Scorenumber(decimal)

The review score, if scores are kept. It is up to the application to define the score range.

Datestring(date-time)

The date of the review.

Likesinteger(int32)

Number of likes. See UpdateProductReviewLikes for information about how to update this.

Dislikesinteger(int32)

Number of dislikes. See UpdateProductReviewLikes for information about how to update this.

IsPublishedboolean or null

Shows if review is published. Applications can have new reviews to not be published and later after internal review on the content have it published.

]
Response
[
  {
    "Id": 0,
    "ReferenceId": 0,
    "Name": "string",
    "Email": "string",
    "Text": "string",
    "Url": "string",
    "ImagePath": "string",
    "Score": 0,
    "Date": "2019-08-24T14:15:22Z",
    "Likes": 0,
    "Dislikes": 0,
    "IsPublished": true
  }
]

Update product review likes

Request

Updates likes/dislikes on review.

Query
productIdinteger(int32)required

Product internal id of the review.

reviewIdinteger(int32)required

The internal id of the review to like/dislike.

doLikebooleanrequired

True or false depending on like or dislike.

cultureCodestring

Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

curl -i -X POST \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/UpdateProductReviewLikes?doLike=true&productId=0&reviewId=0'

Responses

Success

Body
Array [
Idinteger or null(int32)

The internal id of the review. Null or left out when creating new reviews.

ReferenceIdinteger(int32)

The internal product id of the review. Or if the review is for some other entity, then it is the entity Id.

Namestring

The name of the reviewer. MaxLength: 255.

Emailstring

The email address of the reviewer. MaxLength: 255.

Textstring

The review text. MaxLength: max.

Urlstring

A Url to some external source referenced by the reviewer. MaxLength: 255.

ImagePathstring

A Url to some external image uploaded by the reviewer. MaxLength: 255.

Scorenumber(decimal)

The review score, if scores are kept. It is up to the application to define the score range.

Datestring(date-time)

The date of the review.

Likesinteger(int32)

Number of likes. See UpdateProductReviewLikes for information about how to update this.

Dislikesinteger(int32)

Number of dislikes. See UpdateProductReviewLikes for information about how to update this.

IsPublishedboolean or null

Shows if review is published. Applications can have new reviews to not be published and later after internal review on the content have it published.

]
Response
[
  {
    "Id": 0,
    "ReferenceId": 0,
    "Name": "string",
    "Email": "string",
    "Text": "string",
    "Url": "string",
    "ImagePath": "string",
    "Score": 0,
    "Date": "2019-08-24T14:15:22Z",
    "Likes": 0,
    "Dislikes": 0,
    "IsPublished": true
  }
]

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations