STORM API
/
Product Service
/
Parametric

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

List category focus parametrics

Request

Available focus parametrics on a category. Focus parametrics is used when filtering a ListProduct result set.

Query
categoryIdinteger(int32)required

Internal id of category, retrieved from CategoryItem.

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/ListFocusParametrics?categoryId=0'

Responses

Success

Body
Array [
__typestringrequired
Discriminator
Idstring

The internal Id of the Parametric. MaxLength: int.

Namestring

The Name of the Parametric. MaxLength: 255.

Countinteger(int32)

A count of SKUs matched by the FilterItem.

FalseCountinteger(int32)

A count of SKUs not matched by the FilterItem.

Descriptionstring

The Description of the Parametric. MaxLength: max.

ImageKeystring or null(guid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters. Obsolete! - Not supported

]
Response
[
  {
    "__type": "string"
  }
]

List product parametric groups

Request

Lists all parametric groups for the client.

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/ListParametricGroups

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the parametricGroup.

Namestring

The Name of the parametricGroup. MaxLength: 50.

Descriptionstring

The Description of the parametricGroup. MaxLength: 500.

Codestring

The external Code for the parametricGroup. MaxLength: 500.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "Code": "string"
  }
]

List parametric metadata

Request

Lists metadata for parametric, ParametricInfos.

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/ListParametricInfo

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the parametric.

Namestring

The Name of the parametric. MaxLength: 50.

Typestring

The Type of the parametric: ListValue, MultiValue or Value.

Descriptionstring

The Description of the parametric. MaxLength: 500.

Uomstring

The unit of measurement of the values. MaxLength: 50.

IsVariantParametricboolean

Specifies if the current Parametric is for variants only (true) or for the common product (false).

ValueTypestring

The data type of the values for this parametric: Text, Integer, Decimal, Boolean, Html or Date.

Codestring

An externally defined code use to identify this Parametric. MaxLength: 50.

IsHiddenboolean

Indicates if the parametric is hidden or not. This can be used to hide parametrics that are only used in application logic. Only non-hidden parametrics should be displayed in the frontend.

IsGlobalboolean

Indicates if the parametric is global. If it is set as global it exists on all products in all categories.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Type": "string",
    "Description": "string",
    "Uom": "string",
    "IsVariantParametric": true,
    "ValueType": "string",
    "Code": "string",
    "IsHidden": true,
    "IsGlobal": true
  }
]

List parametric list values [Obsolete("Use ListParametricValues2.")]

Request

Reference list of Parametric values.

Query
idinteger(int32)required

The parametric internal id for which values are retrieved.

typeinteger(int32)required

Specifies the type of values to retrieve. Only ListValue(1) and MultiValue(2) are supported.

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/ListParametricValues?id=0&type=0'

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the Entity.

Namestring

The Name of the Entity. MaxLength: 50.

Descriptionstring

The Description of the Entity. MaxLength: 500.

ImageKeystring or null(guid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

Codestring

The Code of the Entity. MaxLength: 50.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "ImageKey": "string",
    "Code": "string"
  }
]

List parametric list values

Request

Reference list of Parametric values.

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/ListParametricValues2

Responses

Success

Body
Array [
Idinteger(int32)

The internal Id of the parametric value.

Namestring

The Name of the parametric value. MaxLength: 255.

Descriptionstring

The Description of the parametric value. MaxLength: max.

Codestring

An externally defined code use to identify this Parametric value. MaxLength: 50.

ImageKeystring or null(guid)

A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

Typestring

MaxLength: 50. Obsolete! - Use ParametricInfo.Type

SortOrderinteger(int32)

Can be specified in Storm Admin for each parametric value.

ParametricIdinteger(int32)

The internal Id of the Parametric that contains this value.

ParametricCodestring

An externally defined code use to identify this Parametric that contains this value. MaxLength: 50.

]
Response
[
  {
    "Id": 0,
    "Name": "string",
    "Description": "string",
    "Code": "string",
    "ImageKey": "string",
    "Type": "string",
    "SortOrder": 0,
    "ParametricId": 0,
    "ParametricCode": "string"
  }
]

List product parametrics

Request

Lists Product Parametric values for a product. What parametric values are returned is defined in the primary Category of the product, or if no primary exists, the first category by sort order. If the product does not exist or does not have a category an empty list is returned. Sort order of the parametric values is taken from the order defined for the category.

Query
productIdinteger(int32)required

Internal id of the Product.

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/ListProductParametrics?productId=0'

Responses

Success

Body
Array [
Namestring

MaxLength: 50.

Valuestring

MaxLength: max. Obsolete! - Use Value2 with Uom

Idinteger(int32)

Internal product parametric id.

ValueIdinteger or null(int32)

Parametric value internal id if the parametric type is single list value.

Descriptionstring
ValueDescriptionstring

MaxLength: max.

IsPrimaryboolean
ValueIdSeedstring

MaxLength: max.

Value2string

The parametric value, if not a ListValue or a MultiValue parametric. MaxLength: max.

Uomstring

The unit of measurement, if any. MaxLength: 50.

GroupIdinteger(int32)

Id of the parametric group.

GroupNamestring

Name of the parametric group. MaxLength: 50.

SortOrderinteger(int32)

Use this to sort the parametric. The value is fetched from the variant group type's sort order in the first place and then from the category's sort order for the parametric values.

Codestring

An external application specific code use to identify this Parametric. MaxLength: 50.

IsHiddenboolean

Indicates if the parametric is hidden or not. This can be used to hide parametrics that are only used in application logic. Only non-hidden parametrics should be displayed in the frontend.

]
Response
[
  {
    "Name": "string",
    "Value": "string",
    "Id": 0,
    "ValueId": 0,
    "Description": "string",
    "ValueDescription": "string",
    "IsPrimary": true,
    "ValueIdSeed": "string",
    "Value2": "string",
    "Uom": "string",
    "GroupId": 0,
    "GroupName": "string",
    "SortOrder": 0,
    "Code": "string",
    "IsHidden": true
  }
]

PriceLists

Operations

Products

Operations

Promotions

Operations

Relations

Operations

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations