Skip to content
STORM API
/
Product Service
/
/
ProductItem2

Documentation ProductService (1.1)

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

Schemas

Schemas

ProductItem

Idinteger(int32)

Internal product id.

Namestring

MaxLength: 255.

SubHeaderstring

MaxLength: 255.

Manufacturerobject(ProductManufacturer)(ProductManufacturer)
Imagestring

MaxLength: 255. Obsolete! - Use ImageKey

CampaignImagestring

MaxLength: 255. Obsolete! - Use ImageKey with preset

LargeImagestring

MaxLength: 255. Obsolete! - Use ImageKey with preset

ThumbnailImagestring

MaxLength: 255. Obsolete! - Use ImageKey with preset

FlagIdSeedstring

A comma separated list of flag internal ids. MaxLength: max.

Pricenumber(decimal)

Best price calculated from available pricelists, excluding VAT.

PriceRecommendednumber or null(decimal)

The rule based price from a priceList, excluding VAT, if specified.

PriceCatalognumber or null(decimal)

The original price, excluding VAT, if specified.

VatRatenumber(decimal)

A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

RecommendedQuantitynumber or null(decimal)

Indicates the default value used as quantity when buying the product. If IsRecommendedQuantityFixed is true, only multiples of this quantity should be allowed.

OnHandobject(OnHand)(OnHand)
OnHandStoreobject(OnHand)(OnHand)
OnHandSupplierobject(OnHand)(OnHand)
Keystring(guid)
Updatedstring or null(date-time)
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.

PopularityRankinteger or null(int32)

A value used to sort items based on popularity. Lower values are more popular.

StatusIdinteger(int32)
VariantNamestring

MaxLength: 255.

VariantImageKeystring or null(guid)
AdditionalImageKeySeedstring

Seed formatted as TypeId[1]:Guid[1], TypeId[2]:Guid[2],.., TypeId[n]:Guid[n]. MaxLength: max.

GroupByKeystring

A key that can be used to group items on product. It is equal to the ProductId for non-variants and equals 'v'+variantId for variants. Should only be used when fetching product lists as variants. MaxLength: int.

VariantFlagIdSeedstring

A comma separated list of flag internal ids. Contains any variant specific flags when fetched in product list AsVariants. MaxLength: max.

PartNostring

Contains the partNo if the product is not a variant. This will be empty if the product has variants. MaxLength: 50.

PriceListIdinteger or null(int32)

Contains the priceList internal id if the product is not a variant. This will be empty if the product has variants.

SortOrderinteger or null(int32)

A custom sort order that can be used when the product item is in a list. The sort order is defined for the primary category of the product item.

CategoryIdinteger or null(int32)

Obsolete! - Use CategoryIdSeed

ParametricListSeedstring

ParametricListSeed contains a comma separated list of id-value pairs separated by colon. Ex: 4711:32,4712:5. Id is the ParametricId and Value is a ListValueId. Note that parametric values with string or html types are not included here since we cannot know if they contain any of the separators. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max.

ParametricMultipleSeedstring

ParametricMultipleSeed contains a comma separated list of id-value pairs separated by colon. Ex: 4711:32,4712:5. Id is the ParametricId and Value is a MultipleValueId. Multiple values for the same parametric are repeated with the same id but different values. Note that parametric values with string or html types are not included here since we cannot know if they contain any of the separators. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max.

ParametricValueSeedstring

ParametricValueSeed contains a comma separated list of id-value pairs separated by colon. Ex: 4711:32,4712:5. Id is the ParametricId and Value is the actual value depending on the parametric type. Note that parametric values with string or html types are not included here since we cannot know if they contain any of the separators. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max.

ParametricTextFieldArray of objects(IdValue)(IdValue)

Global text parametrics configured to to appear in lists.

VariantParametricSeedstring

Contains all ParametricIds that distinguishes these variants for this product. Their specific values are found under ParametricListSeed, ParametricMultiSeed or ParametricValueSeed. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max.

UniqueNamestring

A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500.

StockDisplayBreakPointinteger or null(int32)

A value that can be used for display logic regarding OnHand.

IsBuyableboolean

Indicates if the item is buyable or not. Will always be false if the status is closed. An exception will be thrown if IsBuyable is false and an attempt to buy the item is made. The property can be used to hide or show the buy-button.

SubDescriptionstring

Sub description from Storm Admin. MaxLength: max.

Quantitynumber or null(decimal)

The Quantity, if applicable. Null otherwise. This value will be set when it makes sense such as for included items in StructuralItems.

Typeinteger(int32)

Sku type for this product. Might not be valid if there are variants with different types. Then variants must be examined. Also see ListSkutypes.

CategoryIdSeedstring

A comma separated list of category internal ids ordered so the primary category id is first. MaxLength: max.

IsRecommendedQuantityFixedboolean

If this is set to true only multiples of RecommendedQuantity should be allowed.

Synonymsstring

Synonyms from the Product in Storm. Can be used when indexing the product in any search engine. MaxLength: 500.

VariantUniqueNamestring

A unique name that can be used in Urls and to get a Product. This is the variant's unique name. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500.

IsSubscribableboolean

True if this product can be added in a Subscription. False otherwise.

UnitOfMeasurementstring

Short unit of measurement from Storm Admin. MaxLength: 50.

UnitOfMeasurementCountnumber or null(decimal)

Unit of measurement count

EanCodestring

This will be the EAN code of the selected variant of the product if any. Variants will have this set. MaxLength: 50.

PriceStandardnumber or null(decimal)

The standard price, excluding VAT, if specified.

IsDangerousGoodsboolean

True if this product is considered as dangerous goods. False otherwise.

PriceIncVatnumber(decimal)

The price including VAT calculated on the server side. Should be used to display prices including VAT.

ImageAltTextstring

Default image alt text

{
  "Id": 0,
  "Name": "string",
  "SubHeader": "string",
  "Manufacturer": {
    "Id": 0,
    "Name": "string",
    "PartNo": "string",
    "LogoPath": "string",
    "LogoKey": "string",
    "UniqueName": "string"
  },
  "Image": "string",
  "CampaignImage": "string",
  "LargeImage": "string",
  "ThumbnailImage": "string",
  "FlagIdSeed": "string",
  "Price": 0,
  "PriceRecommended": 0,
  "PriceCatalog": 0,
  "VatRate": 0,
  "RecommendedQuantity": 0,
  "OnHand": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "OnHandStore": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "OnHandSupplier": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "Key": "string",
  "Updated": "2019-08-24T14:15:22Z",
  "ImageKey": "string",
  "PopularityRank": 0,
  "StatusId": 0,
  "VariantName": "string",
  "VariantImageKey": "string",
  "AdditionalImageKeySeed": "string",
  "GroupByKey": "string",
  "VariantFlagIdSeed": "string",
  "PartNo": "string",
  "PriceListId": 0,
  "SortOrder": 0,
  "CategoryId": 0,
  "ParametricListSeed": "string",
  "ParametricMultipleSeed": "string",
  "ParametricValueSeed": "string",
  "ParametricTextField": [
    { … }
  ],
  "VariantParametricSeed": "string",
  "UniqueName": "string",
  "StockDisplayBreakPoint": 0,
  "IsBuyable": true,
  "SubDescription": "string",
  "Quantity": 0,
  "Type": 0,
  "CategoryIdSeed": "string",
  "IsRecommendedQuantityFixed": true,
  "Synonyms": "string",
  "VariantUniqueName": "string",
  "IsSubscribable": true,
  "UnitOfMeasurement": "string",
  "UnitOfMeasurementCount": 0,
  "EanCode": "string",
  "PriceStandard": 0,
  "IsDangerousGoods": true,
  "PriceIncVat": 0,
  "ImageAltText": "string"
}

ProductItem2

Idinteger(int32)

The product internal id for this ProductItem2.

Keystring(guid)
Namestring

MaxLength: 255.

Manufacturerobject(ProductManufacturer)(ProductManufacturer)
CategoryIdSeedstring

A comma separated list of category internal id ordered so the primary category id is first. MaxLength: max.

PartNostring

Contains the part number of the primary Variant, adhering to manual sorting or if sorting isn't set - by lowest available price. MaxLength: 50.

Priceobject(ProductPrice)(ProductPrice)
OnHandobject(OnHand)(OnHand)
OnHandStoreobject(OnHand)(OnHand)
OnHandSupplierobject(OnHand)(OnHand)
VariantsArray of objects(VariantItem)(VariantItem)

The Variants on this ProductItem2. Use expand option Variants to include this property or it will be null.

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.

AdditionalImageKeySeedstring

Seed formatted as TypeId[1]:Guid[1], TypeId[2]:Guid[2],.., TypeId[n]:Guid[n]. MaxLength: max.

FlagIdSeedstring

A comma separated list of flag internal ids. MaxLength: max.

Parametricsobject(ParametricsSeed)(ParametricsSeed)
UniqueNamestring

A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500.

SubHeaderstring

Sub header from the Product in Storm. MaxLength: 255.

SubDescriptionstring

Sub description from the Product in Storm. MaxLength: max.

Synonymsstring

Synonyms from the Product in Storm. Can be used when indexing the product in any search engine. MaxLength: 500.

StockDisplayBreakPointinteger or null(int32)

A value that can be used for display logic regarding OnHand.

IsSubscribableboolean

True if this product can be added in a Subscription. False otherwise.

PopularityRankinteger or null(int32)

A value used to sort items based on popularity. Lower values are more popular.

SortOrderinteger or null(int32)

A custom sort order that can be used when the product item is in a list. The sort order is defined for the primary category of the product item.

Updatedstring or null(date-time)
ImageAltTextstring

Default image alt text

{
  "Id": 0,
  "Key": "string",
  "Name": "string",
  "Manufacturer": {
    "Id": 0,
    "Name": "string",
    "PartNo": "string",
    "LogoPath": "string",
    "LogoKey": "string",
    "UniqueName": "string"
  },
  "CategoryIdSeed": "string",
  "PartNo": "string",
  "Price": {
    "Value": 0,
    "Recommended": 0,
    "Catalog": 0,
    "VatRate": 0,
    "PriceListId": 0,
    "IsBuyable": true,
    "RecommendedQuantity": 0,
    "IsRecommendedQuantityFixed": true,
    "Standard": 0,
    "ValueIncVat": 0
  },
  "OnHand": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "OnHandStore": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "OnHandSupplier": {
    "Value": 0,
    "IncomingValue": 0,
    "NextDeliveryDate": "2019-08-24T14:15:22Z",
    "LeadtimeDayCount": 0,
    "LastChecked": "2019-08-24T14:15:22Z",
    "IsActive": true,
    "IsReturnable": true,
    "Info": [ … ]
  },
  "Variants": [
    { … }
  ],
  "ImageKey": "string",
  "AdditionalImageKeySeed": "string",
  "FlagIdSeed": "string",
  "Parametrics": {
    "ListSeed": "string",
    "MultipleSeed": "string",
    "ValueSeed": "string"
  },
  "UniqueName": "string",
  "SubHeader": "string",
  "SubDescription": "string",
  "Synonyms": "string",
  "StockDisplayBreakPoint": 0,
  "IsSubscribable": true,
  "PopularityRank": 0,
  "SortOrder": 0,
  "Updated": "2019-08-24T14:15:22Z",
  "ImageAltText": "string"
}

ProductItem2PagedList

ItemCountinteger(int32)

Counts the number of products in the list. When fetched with a method that has filters, this value will be to total after the filters have been applied.

ItemsArray of objects(ProductItem2)(ProductItem2)
{
  "ItemCount": 0,
  "Items": [
    { … }
  ]
}

Assortments

Operations

Categories

Operations

Configurations

Operations

Families

Operations

Files

Operations

Filters

Operations

Flags

Operations

InfoTypes

Operations

Manufacturers

Operations

OnHand

Operations

Parametric

Operations

PriceLists

Operations

Products

Operations

Promotions

Operations

Relations

Operations

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations