STORM API
/
Product Service
/
Schemas
/
Review

Documentation ProductService (1.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://demo.storm.io/api/1.1/

Schemas

RelationMetadataItem

Idinteger(int32)

This is the Storm internal product id.

PartNostring

This is the part number if variants are specified

IsVariantSpecificboolean

True if relation is to specific variants.

{
  "Id": 0,
  "PartNo": "string",
  "IsVariantSpecific": true
}

Review

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.

{
  "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
}

SkuType

Idinteger(int32)

The internal id of the sku type.

Namestring

The name of the sku type. MaxLength: 255.

Descriptionstring

The description of the sku type. MaxLength: max.

SortOrderinteger(int32)

The sort order of the sku type.

Groupobject(IdNameDescription)(IdNameDescription)
{
  "Id": 0,
  "Name": "string",
  "Description": "string",
  "SortOrder": 0,
  "Group": {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "ImageKey": "string",
    "Code": "string"
  }
}

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

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations