Documentation ProductService (1.1)

Download OpenAPI description
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

OnHand

Operations

Parametric

Operations

PriceLists

Operations

Products

Operations

Get a product

Request

Gets a Product and its optional variants by internal id. The main product will be based on the product with the supplied id, status permitting.

Query
idinteger(int32)required

The id of the Product. If the product has variants, any id of the variants can be used.

statusSeedstringrequired

Accepts a comma separated string of Status IDs. Lookup references in ListStatuses.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList IDs to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Internal id of company. Checks for specific company bound prices if provided.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/GetProduct?id=0&statusSeed=string'

Responses

Success

Body
Idinteger(int32)

Internal id of the product.

Namestring

The name of the product. When Product is a VariantType, this will be the value of the variant parameter(s). MaxLength: 255.

Descriptionstring

Description of the product. MaxLength: max.

PartNostring

Contains the partNo if the product is not a variant or if the product is fetched by PartNo or VariantUniqueName. If the product has a value here then the selected variant can be found by either PartNo or by Id. MaxLength: 50.

SubHeaderstring

MaxLength: 25.

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

FilesArray of objects(ProductFile)(ProductFile)

If viewed on Product level this will be the product specific files. If viewed on a Variant it will be the variant specific files.

FlagIdSeedstring

A comma separated list of flag internal ids. If viewed on Product level this will be the product specific flags. If viewed on a Variant it will be the variant specific flags. MaxLength: max.

Pricenumber(decimal)

If viewed on Product level this can be a from-price. It will be the price of the cheapest variant. If viewed on a Variant it will be the variant specific price.

PriceCatalognumber or null(decimal)

The original price, if specified. Same rules apply as for Price if it is a Product or a Variant.

PriceRecommendednumber or null(decimal)

The rule based price from a priceList, if specified. Same rules apply as for Price if it is a Product or a Variant.

PriceFreightnumber or null(decimal)

Obsolete! - Use ListDeliveryMethodByProduct if this is required.

PriceFreightVatRatenumber or null(decimal)

Obsolete! - Use ListDeliveryMethodByProduct if this is required.

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)
VariantsArray of objects(Product)(Product)

A list of variants for this Product, if any. If the Product is itself a variant this will be empty.

PriceListIdinteger(int32)
Keystring(guid)
Updatedstring or null(date-time)
NavigationNodeKeystring or null(guid)
CategoryIdinteger or null(int32)

Obsolete! - Use Categories

CategoryNamestring

MaxLength: 50. Obsolete! - Use Categories

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.

VariantParametricsArray of objects(ProductParametric)(ProductParametric)

A list of this product's parametric values. Only used on variants.

StatusIdinteger(int32)
MetaTagsstring

Meta tags for SEO optimization. MaxLength: max.

MetaDescriptionstring

Meta description for SEO optimization. MaxLength: max.

VariantNamestring

The complete variant name of the product. MaxLength: 255.

DescriptionHeaderstring

DescriptionHeader for the product as specified in Storm Admin. MaxLength: 255.

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.

ParametricsArray of objects(ProductParametric)(ProductParametric)

A list of this product's parametric values. Only Parametric values common to all variants for this product will be here. On Variant level this will contain Parametric values with distinguishing values that are not variant parametric values.

FamiliesArray of objects(IdNameDescription)(IdNameDescription)

A list of this product's families.

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. Note that the value can differ for underlying variants.

SubDescriptionstring

Sub description from Storm Admin. MaxLength: max.

Uomstring

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

UomCountnumber 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.

Typeinteger(int32)

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

CategoriesArray of objects(IdValue)(IdValue)

A list of categories ordered so the primary category is first.

IsRecommendedQuantityFixedboolean

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

PopularityRankinteger or null(int32)

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

CostPurchasenumber or null(decimal)

CostPurchase from Storm Admin.

CostUnitnumber or null(decimal)

CostUnit from Storm Admin.

Titlestring

Title for the product. As specified in Storm Admin. MaxLength: 255.

ActualWeightnumber(decimal)

Actual weight or gross weight for the product. As specified in Storm Admin.

CommodityCodestring

Commodity code for the product. As specified in Storm Admin.

IsDropShipOnlyboolean

True if this product is for drop ship only. False otherwise.

Synonymsstring

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

IsSubscribableboolean

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

UnspscCodestring

United Nations Standard Products and Services Code for the product. MaxLength: 50.

PriceStandardnumber or null(decimal)

The standard price, if specified. Same rules apply as for Price if it is a Product or a Variant.

Widthnumber or null(decimal)

The logistic width as defined in Storm.

Heightnumber or null(decimal)

The logistic height as defined in Storm.

Depthnumber or null(decimal)

The logistic depth as defined in Storm.

IsDangerousGoodsboolean

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

HasQuantityBreaksboolean

True if this product has any quantity breaks. False otherwise.

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.

PriceIncVatnumber(decimal)

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

Response
{ "Id": 0, "Name": "string", "Description": "string", "PartNo": "string", "SubHeader": "string", "Manufacturer": { "Id": 0, "Name": "string", "PartNo": "string", "LogoPath": "string", "LogoKey": "string", "UniqueName": "string" }, "Image": "string", "CampaignImage": "string", "LargeImage": "string", "ThumbnailImage": "string", "Files": [ {} ], "FlagIdSeed": "string", "Price": 0, "PriceCatalog": 0, "PriceRecommended": 0, "PriceFreight": 0, "PriceFreightVatRate": 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": [] }, "Variants": [ {} ], "PriceListId": 0, "Key": "string", "Updated": "2019-08-24T14:15:22Z", "NavigationNodeKey": "string", "CategoryId": 0, "CategoryName": "string", "ImageKey": "string", "VariantParametrics": [ {} ], "StatusId": 0, "MetaTags": "string", "MetaDescription": "string", "VariantName": "string", "DescriptionHeader": "string", "UniqueName": "string", "StockDisplayBreakPoint": 0, "Parametrics": [ {} ], "Families": [ {} ], "IsBuyable": true, "SubDescription": "string", "Uom": "string", "UomCount": 0, "EanCode": "string", "Type": 0, "Categories": [ {} ], "IsRecommendedQuantityFixed": true, "PopularityRank": 0, "CostPurchase": 0, "CostUnit": 0, "Title": "string", "ActualWeight": 0, "CommodityCode": "string", "IsDropShipOnly": true, "Synonyms": "string", "IsSubscribable": true, "UnspscCode": "string", "PriceStandard": 0, "Width": 0, "Height": 0, "Depth": 0, "IsDangerousGoods": true, "HasQuantityBreaks": true, "GroupByKey": "string", "PriceIncVat": 0 }

Get a product by part no

Request

Gets a Product and its optional variants by partNo. The main product will be based on the product with the supplied partNo, status permitting.

Query
partNostringrequired

Part number of the product to get.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/GetProductByPartNo?partNo=string&statusSeed=string'

Responses

Success

Body
Idinteger(int32)

Internal id of the product.

Namestring

The name of the product. When Product is a VariantType, this will be the value of the variant parameter(s). MaxLength: 255.

Descriptionstring

Description of the product. MaxLength: max.

PartNostring

Contains the partNo if the product is not a variant or if the product is fetched by PartNo or VariantUniqueName. If the product has a value here then the selected variant can be found by either PartNo or by Id. MaxLength: 50.

SubHeaderstring

MaxLength: 25.

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

FilesArray of objects(ProductFile)(ProductFile)

If viewed on Product level this will be the product specific files. If viewed on a Variant it will be the variant specific files.

FlagIdSeedstring

A comma separated list of flag internal ids. If viewed on Product level this will be the product specific flags. If viewed on a Variant it will be the variant specific flags. MaxLength: max.

Pricenumber(decimal)

If viewed on Product level this can be a from-price. It will be the price of the cheapest variant. If viewed on a Variant it will be the variant specific price.

PriceCatalognumber or null(decimal)

The original price, if specified. Same rules apply as for Price if it is a Product or a Variant.

PriceRecommendednumber or null(decimal)

The rule based price from a priceList, if specified. Same rules apply as for Price if it is a Product or a Variant.

PriceFreightnumber or null(decimal)

Obsolete! - Use ListDeliveryMethodByProduct if this is required.

PriceFreightVatRatenumber or null(decimal)

Obsolete! - Use ListDeliveryMethodByProduct if this is required.

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)
VariantsArray of objects(Product)(Product)

A list of variants for this Product, if any. If the Product is itself a variant this will be empty.

PriceListIdinteger(int32)
Keystring(guid)
Updatedstring or null(date-time)
NavigationNodeKeystring or null(guid)
CategoryIdinteger or null(int32)

Obsolete! - Use Categories

CategoryNamestring

MaxLength: 50. Obsolete! - Use Categories

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.

VariantParametricsArray of objects(ProductParametric)(ProductParametric)

A list of this product's parametric values. Only used on variants.

StatusIdinteger(int32)
MetaTagsstring

Meta tags for SEO optimization. MaxLength: max.

MetaDescriptionstring

Meta description for SEO optimization. MaxLength: max.

VariantNamestring

The complete variant name of the product. MaxLength: 255.

DescriptionHeaderstring

DescriptionHeader for the product as specified in Storm Admin. MaxLength: 255.

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.

ParametricsArray of objects(ProductParametric)(ProductParametric)

A list of this product's parametric values. Only Parametric values common to all variants for this product will be here. On Variant level this will contain Parametric values with distinguishing values that are not variant parametric values.

FamiliesArray of objects(IdNameDescription)(IdNameDescription)

A list of this product's families.

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. Note that the value can differ for underlying variants.

SubDescriptionstring

Sub description from Storm Admin. MaxLength: max.

Uomstring

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

UomCountnumber 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.

Typeinteger(int32)

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

CategoriesArray of objects(IdValue)(IdValue)

A list of categories ordered so the primary category is first.

IsRecommendedQuantityFixedboolean

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

PopularityRankinteger or null(int32)

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

CostPurchasenumber or null(decimal)

CostPurchase from Storm Admin.

CostUnitnumber or null(decimal)

CostUnit from Storm Admin.

Titlestring

Title for the product. As specified in Storm Admin. MaxLength: 255.

ActualWeightnumber(decimal)

Actual weight or gross weight for the product. As specified in Storm Admin.

CommodityCodestring

Commodity code for the product. As specified in Storm Admin.

IsDropShipOnlyboolean

True if this product is for drop ship only. False otherwise.

Synonymsstring

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

IsSubscribableboolean

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

UnspscCodestring

United Nations Standard Products and Services Code for the product. MaxLength: 50.

PriceStandardnumber or null(decimal)

The standard price, if specified. Same rules apply as for Price if it is a Product or a Variant.

Widthnumber or null(decimal)

The logistic width as defined in Storm.

Heightnumber or null(decimal)

The logistic height as defined in Storm.

Depthnumber or null(decimal)

The logistic depth as defined in Storm.

IsDangerousGoodsboolean

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

HasQuantityBreaksboolean

True if this product has any quantity breaks. False otherwise.

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.

PriceIncVatnumber(decimal)

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

Response
{ "Id": 0, "Name": "string", "Description": "string", "PartNo": "string", "SubHeader": "string", "Manufacturer": { "Id": 0, "Name": "string", "PartNo": "string", "LogoPath": "string", "LogoKey": "string", "UniqueName": "string" }, "Image": "string", "CampaignImage": "string", "LargeImage": "string", "ThumbnailImage": "string", "Files": [ {} ], "FlagIdSeed": "string", "Price": 0, "PriceCatalog": 0, "PriceRecommended": 0, "PriceFreight": 0, "PriceFreightVatRate": 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": [] }, "Variants": [ {} ], "PriceListId": 0, "Key": "string", "Updated": "2019-08-24T14:15:22Z", "NavigationNodeKey": "string", "CategoryId": 0, "CategoryName": "string", "ImageKey": "string", "VariantParametrics": [ {} ], "StatusId": 0, "MetaTags": "string", "MetaDescription": "string", "VariantName": "string", "DescriptionHeader": "string", "UniqueName": "string", "StockDisplayBreakPoint": 0, "Parametrics": [ {} ], "Families": [ {} ], "IsBuyable": true, "SubDescription": "string", "Uom": "string", "UomCount": 0, "EanCode": "string", "Type": 0, "Categories": [ {} ], "IsRecommendedQuantityFixed": true, "PopularityRank": 0, "CostPurchase": 0, "CostUnit": 0, "Title": "string", "ActualWeight": 0, "CommodityCode": "string", "IsDropShipOnly": true, "Synonyms": "string", "IsSubscribable": true, "UnspscCode": "string", "PriceStandard": 0, "Width": 0, "Height": 0, "Depth": 0, "IsDangerousGoods": true, "HasQuantityBreaks": true, "GroupByKey": "string", "PriceIncVat": 0 }

Get a product by unique name

Request

Gets a Product and its optional variants by the uniqueName. The main product will be based on the product with the supplied name, status permitting.

Query
uniqueNamestringrequired

Unique name of the product

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/GetProductByUniqueName?statusSeed=string&uniqueName=string'

Responses

Success

Body
Idinteger(int32)

Internal id of the product.

Namestring

The name of the product. When Product is a VariantType, this will be the value of the variant parameter(s). MaxLength: 255.

Descriptionstring

Description of the product. MaxLength: max.

PartNostring

Contains the partNo if the product is not a variant or if the product is fetched by PartNo or VariantUniqueName. If the product has a value here then the selected variant can be found by either PartNo or by Id. MaxLength: 50.

SubHeaderstring

MaxLength: 25.

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

FilesArray of objects(ProductFile)(ProductFile)

If viewed on Product level this will be the product specific files. If viewed on a Variant it will be the variant specific files.

FlagIdSeedstring

A comma separated list of flag internal ids. If viewed on Product level this will be the product specific flags. If viewed on a Variant it will be the variant specific flags. MaxLength: max.

Pricenumber(decimal)

If viewed on Product level this can be a from-price. It will be the price of the cheapest variant. If viewed on a Variant it will be the variant specific price.

PriceCatalognumber or null(decimal)

The original price, if specified. Same rules apply as for Price if it is a Product or a Variant.

PriceRecommendednumber or null(decimal)

The rule based price from a priceList, if specified. Same rules apply as for Price if it is a Product or a Variant.

PriceFreightnumber or null(decimal)

Obsolete! - Use ListDeliveryMethodByProduct if this is required.

PriceFreightVatRatenumber or null(decimal)

Obsolete! - Use ListDeliveryMethodByProduct if this is required.

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)
VariantsArray of objects(Product)(Product)

A list of variants for this Product, if any. If the Product is itself a variant this will be empty.

PriceListIdinteger(int32)
Keystring(guid)
Updatedstring or null(date-time)
NavigationNodeKeystring or null(guid)
CategoryIdinteger or null(int32)

Obsolete! - Use Categories

CategoryNamestring

MaxLength: 50. Obsolete! - Use Categories

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.

VariantParametricsArray of objects(ProductParametric)(ProductParametric)

A list of this product's parametric values. Only used on variants.

StatusIdinteger(int32)
MetaTagsstring

Meta tags for SEO optimization. MaxLength: max.

MetaDescriptionstring

Meta description for SEO optimization. MaxLength: max.

VariantNamestring

The complete variant name of the product. MaxLength: 255.

DescriptionHeaderstring

DescriptionHeader for the product as specified in Storm Admin. MaxLength: 255.

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.

ParametricsArray of objects(ProductParametric)(ProductParametric)

A list of this product's parametric values. Only Parametric values common to all variants for this product will be here. On Variant level this will contain Parametric values with distinguishing values that are not variant parametric values.

FamiliesArray of objects(IdNameDescription)(IdNameDescription)

A list of this product's families.

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. Note that the value can differ for underlying variants.

SubDescriptionstring

Sub description from Storm Admin. MaxLength: max.

Uomstring

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

UomCountnumber 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.

Typeinteger(int32)

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

CategoriesArray of objects(IdValue)(IdValue)

A list of categories ordered so the primary category is first.

IsRecommendedQuantityFixedboolean

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

PopularityRankinteger or null(int32)

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

CostPurchasenumber or null(decimal)

CostPurchase from Storm Admin.

CostUnitnumber or null(decimal)

CostUnit from Storm Admin.

Titlestring

Title for the product. As specified in Storm Admin. MaxLength: 255.

ActualWeightnumber(decimal)

Actual weight or gross weight for the product. As specified in Storm Admin.

CommodityCodestring

Commodity code for the product. As specified in Storm Admin.

IsDropShipOnlyboolean

True if this product is for drop ship only. False otherwise.

Synonymsstring

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

IsSubscribableboolean

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

UnspscCodestring

United Nations Standard Products and Services Code for the product. MaxLength: 50.

PriceStandardnumber or null(decimal)

The standard price, if specified. Same rules apply as for Price if it is a Product or a Variant.

Widthnumber or null(decimal)

The logistic width as defined in Storm.

Heightnumber or null(decimal)

The logistic height as defined in Storm.

Depthnumber or null(decimal)

The logistic depth as defined in Storm.

IsDangerousGoodsboolean

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

HasQuantityBreaksboolean

True if this product has any quantity breaks. False otherwise.

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.

PriceIncVatnumber(decimal)

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

Response
{ "Id": 0, "Name": "string", "Description": "string", "PartNo": "string", "SubHeader": "string", "Manufacturer": { "Id": 0, "Name": "string", "PartNo": "string", "LogoPath": "string", "LogoKey": "string", "UniqueName": "string" }, "Image": "string", "CampaignImage": "string", "LargeImage": "string", "ThumbnailImage": "string", "Files": [ {} ], "FlagIdSeed": "string", "Price": 0, "PriceCatalog": 0, "PriceRecommended": 0, "PriceFreight": 0, "PriceFreightVatRate": 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": [] }, "Variants": [ {} ], "PriceListId": 0, "Key": "string", "Updated": "2019-08-24T14:15:22Z", "NavigationNodeKey": "string", "CategoryId": 0, "CategoryName": "string", "ImageKey": "string", "VariantParametrics": [ {} ], "StatusId": 0, "MetaTags": "string", "MetaDescription": "string", "VariantName": "string", "DescriptionHeader": "string", "UniqueName": "string", "StockDisplayBreakPoint": 0, "Parametrics": [ {} ], "Families": [ {} ], "IsBuyable": true, "SubDescription": "string", "Uom": "string", "UomCount": 0, "EanCode": "string", "Type": 0, "Categories": [ {} ], "IsRecommendedQuantityFixed": true, "PopularityRank": 0, "CostPurchase": 0, "CostUnit": 0, "Title": "string", "ActualWeight": 0, "CommodityCode": "string", "IsDropShipOnly": true, "Synonyms": "string", "IsSubscribable": true, "UnspscCode": "string", "PriceStandard": 0, "Width": 0, "Height": 0, "Depth": 0, "IsDangerousGoods": true, "HasQuantityBreaks": true, "GroupByKey": "string", "PriceIncVat": 0 }

List best selling products [Obsolete("Use ListBestsellingProducts2")]

Request

Returns the best selling products based on supplied parameters.

Query
searchStringstring

Free text search string. Minimum of 2 characters required.

categorySeedstring

Accepts a comma separated string of Category internal ids, retrieved from CategoryItem.

manufacturerSeedstring

Accepts a comma separated string of Manufacturer internal ids.

flagSeedstring

Accepts a comma separated string of Flag internal ids. Lookup references in ListFlags.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

parametricsstring

Parametric values formatted as ListParameters = L[ParametricId][ListId], MultiParameters = M[ParametricId][MultipleId], ValueParameters = V[ParametricId]_[ValueFrom]-[ValueTo] with asterisk () as separator. Sample: L10_45M20_254M20_145V60_256-1024*V70_1.4-1.9. The logical operation between values is AND.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied. If omitted

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListBestsellingProducts?assortmentSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List best selling products (v2)

Request

Returns the best selling products based on supplied parameters.

Query
searchStringstring

Free text search string. Minimum of 2 characters required.

categorySeedstring

Accepts a comma separated string of Category internal ids, retrieved from CategoryItem.

manufacturerSeedstring

Accepts a comma separated string of Manufacturer internal ids.

flagSeedstring

Accepts a comma separated string of Flag internal ids. Lookup references in ListFlags.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

parametricsstring

Parametric values formatted as ListParameters = L[ParametricId][ListId], MultiParameters = M[ParametricId][MultipleId], ValueParameters = V[ParametricId]_[ValueFrom]-[ValueTo] with asterisk () as separator. Sample: L10_45M20_254M20_145V60_256-1024*V70_1.4-1.9. The logical operation between values is AND.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied. If omitted

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListBestsellingProducts2?assortmentSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List best selling products by company

Request

Main product list based on best selling items for a company

Query
customerIdinteger(int32)

Customer internal id. Checks for specific customer bound prices if provided.

companyIdinteger(int32)

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

fromDatestring(date-time)required

Orders from this date will only be included in the calculation. Format: yyyy-mm-ddThh:mm:ss.nnn[z], example 2024-08-01T12:59:59.000Z

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

sizestring

Number of items to display. Default is 50.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListBestSellingProductsByCompany?fromDate=2019-08-24T14%3A15%3A22Z&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List best selling products by node [Obsolete("Use ListBestsellingProductsByNode2")]

Request

Returns the best selling products based on supplied parameters by Navigation Node.

Query
nodeKeystring(guid)required

Key from NavigationNode.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied. If omitted

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListBestsellingProductsByNode?assortmentSeed=string&nodeKey=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List best selling products by node (v2)

Request

Returns the best selling products based on supplied parameters by Navigation Node.

Query
nodeKeystring(guid)required

Key from NavigationNode.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied. If omitted

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListBestsellingProductsByNode2?assortmentSeed=string&nodeKey=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List historical best prices

Request

Lists historical best prices for a product going back 30 days.

Query
partNostringrequired

The part number of the Product.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListHistoricalBestPrices?partNo=string'

Responses

Success

BodyArray [
PartNostring

The part number for this product. MaxLength: 50.

PriceListIdinteger(int32)

The pricelist internal id for the price.

Pricenumber(decimal)

The actual price value, excluding VAT.

PriceIncVatnumber(decimal)

The actual price value, including VAT.

VatRatenumber(decimal)

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

Updatedstring(date-time)

Time when this price started to be best price.

]
Response
[ { "PartNo": "string", "PriceListId": 0, "Price": 0, "PriceIncVat": 0, "VatRate": 0, "Updated": "2019-08-24T14:15:22Z" } ]

List products included in structure

Request

Returns a list of included products for structural products. Note that this is on sku level.

Query
partNostringrequired

The partNo of the selected structural product.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids for the included products. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids for the included products. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Not used. The items are returned in the sort order specified by the structure item in Storm.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

filterstring

Property values to filter on. The return value's ItemCount will be the number of items after filters have been applied. General format: 'filterName|value specification'. Multiple filters are separated by a semi colon. See Filter.Name for valid values and the different Filter entities for value specifications. Sample: catf|11946,11947;mfrf|7276;ohf|true;flgf|42,46;prcf|true_10-20;parf|L6360_13239M6355_3387M6355_3390!V60_256-1024*V70_1.4-1.9. The logical operator between comma separated values in catf, mfrf and flgf is OR while parf values use AND.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListIncludedProducts?assortmentSeed=string&partNo=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List popular products [Obsolete("Use ListPopularProducts2")]

Request

Returns the most popular products based on supplied parameters.

Query
searchStringstring

Free text search string. Minimum of 2 characters required.

categorySeedstring

Accepts a comma separated string of Category internal ids, retrieved from CategoryItem.

manufacturerSeedstring

Accepts a comma separated string of Manufacturer internal ids.

flagSeedstring

Accepts a comma separated string of Flag internal ids. Lookup references in ListFlags.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

parametricsstring

Parametric values formatted as ListParameters = L[ParametricId][ListId], MultiParameters = M[ParametricId][MultipleId], ValueParameters = V[ParametricId]_[ValueFrom]-[ValueTo] with asterisk () as separator. Sample: L10_45M20_254M20_145V60_256-1024*V70_1.4-1.9. The logical operation between values is AND.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListPopularProducts?assortmentSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List popular products (v2)

Request

Returns the most popular products based on supplied parameters.

Query
searchStringstring

Free text search string. Minimum of 2 characters required.

categorySeedstring

Accepts a comma separated string of Category internal ids, retrieved from CategoryItem.

manufacturerSeedstring

Accepts a comma separated string of Manufacturer internal ids.

flagSeedstring

Accepts a comma separated string of Flag internal ids. Lookup references in ListFlags.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

parametricsstring

Parametric values formatted as ListParameters = L[ParametricId][ListId], MultiParameters = M[ParametricId][MultipleId], ValueParameters = V[ParametricId]_[ValueFrom]-[ValueTo] with asterisk () as separator. Sample: L10_45M20_254M20_145V60_256-1024*V70_1.4-1.9. The logical operation between values is AND.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListPopularProducts2?assortmentSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List popular products by node [Obsolete("Use ListPopularProductsByNode2")]

Request

Returns the most popular products based on supplied parameters by Navigation Node.

Query
nodeKeystring(guid)required

Key from NavigationNode.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListPopularProductsByNode?assortmentSeed=string&nodeKey=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List popular products by node (v2)

Request

Returns the most popular products based on supplied parameters by Navigation Node.

Query
nodeKeystring(guid)required

Key from NavigationNode.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListPopularProductsByNode2?assortmentSeed=string&nodeKey=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List product quantity break prices

Request

Gets a ProductPriceQtyBreakList. The list contains ProductPrices representing the price for each given minimum quantity bought.

Query
idinteger(int32)required

The internal id of the Product.

storeSeedstring

Accepts a comma separated string of store internal IDs.

pricelistSeedstring

A comma separated list of pricelist internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

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

Responses

Success

BodyArray [
PartNostring

The part number for this product.

QtyBreaknumber(decimal)

The minimum quantity needed to purchase to receive the ProductPrice.

ProductPriceobject(ProductPrice)(ProductPrice)
]
Response
[ { "PartNo": "string", "QtyBreak": 0, "ProductPrice": {} } ]

List products [Obsolete("Use ListProducts2")]

Request

Main product list.

Query
searchStringstring

Free text search string.

categorySeedstring

Accepts a comma separated string of Category IDs, retrieved from CategoryItem.

manufacturerSeedstring

Accepts a comma separated string of Manufacturer IDs.

flagSeedstring

Accepts a comma separated string of Flag internal ids. Lookup references in ListFlags.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

parametricsstring

Parametric values formatted as ListParameters = L[ParametricId][ListId], MultiParameters = M[ParametricId][MultipleId], ValueParameters = V[ParametricId]_[ValueFrom]-[ValueTo] with asterisk () as separator. Sample: L10_45M20_254M20_145V60_256-1024*V70_1.4-1.9. The logical operation between values is AND.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

filterstring

Property values to filter on. The return value's ItemCount will be the number of items after filters have been applied. General format: 'filterName|value specification'. See Filter.Name for valid values and the different Filter entities for value specifications. Sample: catf|11946,11947;mfrf|7276;ohf|true;flgf|42,46;prcf|true_10-20;parf|L6360_13239M6355_3387M6355_3390!V60_256-1024*V70_1.4-1.9. The logical operator between comma separated values in catf, mfrf and flgf is OR while parf values use AND.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProducts?assortmentSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List products (v2)

Request

Main product list.

Query
searchStringstring

Free text search string.

categorySeedstring

Accepts a comma separated string of Category internal ids, retrieved from CategoryItem.

manufacturerSeedstring

Accepts a comma separated string of Manufacturer internal ids.

flagSeedstring

Accepts a comma separated string of Flag internal ids. Lookup references in ListFlags.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

parametricsstring

Parametric values formatted as ListParameters = L[ParametricId][ListId], MultiParameters = M[ParametricId][MultipleId], ValueParameters = V[ParametricId]_[ValueFrom]-[ValueTo] with asterisk () as separator. Sample: L10_45M20_254M20_145V60_256-1024*V70_1.4-1.9. The logical operation between values is AND.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

filterstring

Property values to filter on. The return value's ItemCount will be the number of items after filters have been applied. General format: 'filterName|value specification'. See Filter.Name for valid values and the different Filter entities for value specifications. Sample: catf|11946,11947;mfrf|7276;ohf|true;flgf|42,46;prcf|true_10-20;parf|L6360_13239M6355_3387M6355_3390!V60_256-1024*V70_1.4-1.9. The logical operator between comma separated values in catf, mfrf and flgf is OR while parf values use AND.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProducts2?assortmentSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List products by customer

Request

Main product list and prices based on customer priceLists.

Query
searchStringstring

Free text search string.

categorySeedstring

Accepts a comma separated string of Category internal ids, retrieved from CategoryItem.

manufacturerSeedstring

Accepts a comma separated string of Manufacturer internal ids.

flagSeedstring

Accepts a comma separated string of Flag internal ids. Lookup references in ListFlags.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

parametricsstring

Parametric values formatted as ListParameters = L[ParametricId][ListId], MultiParameters = M[ParametricId][MultipleId], ValueParameters = V[ParametricId]_[ValueFrom]-[ValueTo] with asterisk () as separator. Sample: L10_45M20_254M20_145V60_256-1024*V70_1.4-1.9. The logical operation between values is AND.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdinteger(int32)

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

filterstring

Property values to filter on. The return value's ItemCount will be the number of items after filters have been applied. General format: 'filterName|value specification'. See Filter.Name for valid values and the different Filter entities for value specifications. Sample: catf|11946,11947;mfrf|7276;ohf|true;flgf|42,46;prcf|true_10-20;parf|L6360_13239M6355_3387M6355_3390!V60_256-1024*V70_1.4-1.9. The logical operator between comma separated values in catf, mfrf and flgf is OR while parf values use AND.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductsByCustomer?assortmentSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List products by families

Request

Main product list.

Query
categorySeedstring

Accepts a comma separated string of Category internal ids, retrieved from CategoryItem.

manufacturerSeedstring

Accepts a comma separated string of Manufacturer internal ids.

flagSeedstring

Accepts a comma separated string of Flag internal ids. Lookup references in ListFlags.

familySeedstring

Accepts a comma separated string of family IDs. Lookup references in ListFamilies.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

parametricsstring

Parametric values formatted as ListParameters = L[ParametricId][ListId], MultiParameters = M[ParametricId][MultipleId], ValueParameters = V[ParametricId]_[ValueFrom]-[ValueTo] with asterisk () as separator. Sample: L10_45M20_254M20_145V60_256-1024*V70_1.4-1.9. The logical operation between values is AND.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

filterstring

Property values to filter on. The return value's ItemCount will be the number of items after filters have been applied. General format: 'filterName|value specification'. See Filter.Name for valid values and the different Filter entities for value specifications. Sample: catf|11946,11947;mfrf|7276;ohf|true;flgf|42,46;prcf|true_10-20;parf|L6360_13239M6355_3387M6355_3390!V60_256-1024*V70_1.4-1.9. The logical operator between comma separated values in catf, mfrf and flgf is OR while parf values use AND.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductsByFamilies?assortmentSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List product variants by product ids

Request

Returns all variants for the product as a ProductItemList.

Query
productIdinteger(int32)required

Accepts a comma separated string of Product IDs.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

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

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List products by ids [Obsolete("Use ListProductsByIds2")]

Request

Main product list.

Query
idSeedstringrequired

Accepts a comma separated string of Product IDs.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductsByIds?idSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List products by ids (v2)

Request

Main product list.

Query
idSeedstringrequired

Accepts a comma separated string of Product IDs.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted. Only specified ids will be returned if returnAllVariants is set to false. Set returnAllVariants to true to return all.

returnAllVariantsstring

Specifies if the result should include all variants or just the specified. Default is false.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductsByIds2?idSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List products by ids (v3)

Request

Main product list.

Query
idSeedstringrequired

Accepts a comma separated string of Product IDs.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

filterstring

Property values to filter on. The return value's ItemCount will be the number of items after filters have been applied. General format: 'filterName|value specification'. See Filter.Name for valid values and the different Filter entities for value specifications. Sample: catf|11946,11947;mfrf|7276;ohf|true;flgf|42,46;prcf|true_10-20;parf|L6360_13239M6355_3387M6355_3390!V60_256-1024*V70_1.4-1.9. The logical operator between comma separated values in catf, mfrf and flgf is OR while parf values use AND.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted. Only specified ids will be returned if returnAllVariants is set to false. Set returnAllVariants to true to return all.

returnAllVariantsstring

Specifies if the result should include all variants or just the specified. Default is false.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductsByIds3?idSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List products by node [Obsolete("Use ListProductsByNode2")]

Request

Main product list by Navigation Node.

Query
nodeKeystring(guid)required

Key from NavigationNode.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

filterstring

Property values to filter on. The return value's ItemCount will be the number of items after filters have been applied. General format: 'filterName|value specification'. See Filter.Name for valid values and the different Filter entities for value specifications. Sample: catf|11946,11947;mfrf|7276;ohf|true;flgf|42,46;prcf|true_10-20;parf|L6360_13239M6355_3387M6355_3390!V60_256-1024*V70_1.4-1.9. The logical operator between comma separated values in catf, mfrf and flgf is OR while parf values use AND.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductsByNode?assortmentSeed=string&nodeKey=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List products by node (v2)

Request

Main product list by Navigation Node.

Query
nodeKeystring(guid)required

Key from NavigationNode.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

filterstring

Property values to filter on. The return value's ItemCount will be the number of items after filters have been applied. General format: 'filterName|value specification'. See Filter.Name for valid values and the different Filter entities for value specifications. Sample: catf|11946,11947;mfrf|7276;ohf|true;flgf|42,46;prcf|true_10-20;parf|L6360_13239M6355_3387M6355_3390!V60_256-1024*V70_1.4-1.9. The logical operator between comma separated values in catf, mfrf and flgf is OR while parf values use AND.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductsByNode2?assortmentSeed=string&nodeKey=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List products by part numbers

Request

Main product list.

Query
partNoSeedstringrequired

Accepts a comma separated string of partNos.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted. Only specified ids will be returned if returnAllVariants is set to false. Set returnAllVariants to true to return all.

returnAllVariantsstring

Specifies if the result should include all variants or just the specified. Default is false.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductsByPartNos?partNoSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List products by pricelists

Request

Main product list and prices based on priceLists.

Query
searchStringstring

Free text search string.

categorySeedstring

Accepts a comma separated string of Category internal ids, retrieved from CategoryItem.

manufacturerSeedstring

Accepts a comma separated string of Manufacturer internal ids.

flagSeedstring

Accepts a comma separated string of Flag internal ids. Lookup references in ListFlags.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

parametricsstring

Parametric values formatted as ListParameters = L[ParametricId][ListId], MultiParameters = M[ParametricId][MultipleId], ValueParameters = V[ParametricId]_[ValueFrom]-[ValueTo] with asterisk () as separator. Sample: L10_45M20_254M20_145V60_256-1024*V70_1.4-1.9. The logical operation between values is AND.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

filterstring

Property values to filter on. The return value's ItemCount will be the number of items after filters have been applied. General format: 'filterName|value specification'. See Filter.Name for valid values and the different Filter entities for value specifications. Sample: catf|11946,11947;mfrf|7276;ohf|true;flgf|42,46;prcf|true_10-20;parf|L6360_13239M6355_3387M6355_3390!V60_256-1024*V70_1.4-1.9. The logical operator between comma separated values in catf, mfrf and flgf is OR while parf values use AND.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductsByPricelist?assortmentSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List products by pricelists (v2)

Request

Main product list (v2) and prices based on priceLists.

Query
searchStringstring

Free text search string.

categorySeedstring

Accepts a comma separated string of Category internal ids, retrieved from CategoryItem.

manufacturerSeedstring

Accepts a comma separated string of Manufacturer internal ids.

flagSeedstring

Accepts a comma separated string of Flag internal ids. Lookup references in ListFlags.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

parametricsstring

Parametric values formatted as ListParameters = L[ParametricId][ListId], MultiParameters = M[ParametricId][MultipleId], ValueParameters = V[ParametricId]_[ValueFrom]-[ValueTo] with asterisk () as separator. Sample: L10_45M20_254M20_145V60_256-1024*V70_1.4-1.9. The logical operation between values is AND.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

filterstring

Property values to filter on. The return value's ItemCount will be the number of items after filters have been applied. General format: 'filterName|value specification'. See Filter.Name for valid values and the different Filter entities for value specifications. Sample: catf|11946,11947;mfrf|7276;ohf|true;flgf|42,46;prcf|true_10-20;parf|L6360_13239M6355_3387M6355_3390!V60_256-1024*V70_1.4-1.9. The logical operator between comma separated values in catf, mfrf and flgf is OR while parf values use AND.

expandstring

An expand option that specifies what expansions should be made on the ProductItem2 entity. Valid values are: None, Variants, Price, OnHand, OnHandStore, OnHandSupplier and Parameters. These can be comma separated. Use Full for all. Default is Full. None will return just the ProductItem without expansions.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductsByPriceList2?assortmentSeed=string&statusSeed=string'

Responses

Success

Body
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)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List products by promotion requirement

Request

Lists all products by promotion requirements.

Query
promotionIdinteger(int32)required

PromotionId. See Shopping.ListPromotions for a List of promotions.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

pageNostring

Page numbers start with 1. Default is 1. If you specify a pageNo outside the range of items, an empty list will be returned. PageSize is mandatory for pageNo to work.

pageSizestring

Number of items to display per page. Mandatory if using pageNo.

filterstring

Property values to filter on. The return value's ItemCount will be the number of items after filters have been applied. General format: 'filterName|value specification'. See Filter.Name for valid values and the different Filter entities for value specifications. Sample: catf|11946,11947;mfrf|7276;ohf|true;flgf|42,46;prcf|true_10-20;parf|L6360_13239M6355_3387M6355_3390!V60_256-1024*V70_1.4-1.9. The logical operator between comma separated values in catf, mfrf and flgf is OR while parf values use AND.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductsByPromotionRequirement?assortmentSeed=string&promotionId=0&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List products in family [Obsolete("Use ListProductsInFamilies2")]

Request

Returns other products in the same family for the current product.

Query
productIdinteger(int32)required

The internal product id for which family products are listed.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductsInFamilies?assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List product in family (v2)

Request

Returns other products in the same family for the current product.

Query
productIdinteger(int32)required

The internal product id for which family products are listed.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

asVariantsstring

Specifies if the output should be grouped as products or as variants. Default is false which returns a list of products. Set to true if variants are wanted.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListProductsInFamilies2?assortmentSeed=string&productId=0&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

List popular products [Obsolete("Use ListPopularProducts2 or ListPopularProductsByNode2")]

Request

Returns the most popular products based on supplied parameters.

Query
categorySeedstring

Accepts a comma separated string of Category internal ids, retrieved from CategoryItem.

manufacturerSeedstring

Accepts a comma separated string of Manufacturer internal ids.

flagSeedstring

Accepts a comma separated string of Flag internal ids. Lookup references in ListFlags.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

parametricsstring

Parametric values formatted as ListParameters = L[ParametricId][ListId], MultiParameters = M[ParametricId][MultipleId], ValueParameters = V[ParametricId]_[ValueFrom]-[ValueTo] with asterisk () as separator. Sample: L10_45M20_254M20_145V60_256-1024*V70_1.4-1.9. The logical operation between values is AND.

storeSeedstring

Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

pricelistSeedstring

A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Customer internal id. Checks for specific customer bound prices if provided.

companyIdstring

Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

sortstring

Sort order as formatted [Property] [Asc/Desc] with comma as separator. Supported properties for sorting on the server are PopularityRank, Name, Price and SortOrder.

sizestring

Number of items to display.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/ListTopProducts?assortmentSeed=string&statusSeed=string'

Responses

Success

Body
ItemCountinteger(int32)

Counts the number of products in the list. If the list is fetched with AsVariants set to true ItemCount will still just count the number of products. Not items 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(ProductItem)(ProductItem)
Response
{ "ItemCount": 0, "Items": [ {} ] }

Search products light [Obsolete("Deprecated, use SearchProductsLite2")]

Request

Query
searchStringstringrequired
statusIdinteger(int32)required
pricelistSeedstringrequired
customerIdstringrequired
companyIdstringrequired
sizestringrequired
cultureCodestring
currencyIdstringrequired
salesAreaIdstring
curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/SearchProductsLite?companyId=string&currencyId=string&customerId=string&pricelistSeed=string&searchString=string&size=string&statusId=0'

Responses

Success

BodyArray [
Idinteger(int32)

Internal product id.

Namestring

MaxLength: 255.

ManufacturerNamestring

MaxLength: 100.

Pricenumber(decimal)

The best price excluding VAT for the product.

VatRatenumber(decimal)

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

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.

UniqueNamestring

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

CategoryIdinteger or null(int32)
PriceIncVatnumber(decimal)

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

]
Response
[ { "Id": 0, "Name": "string", "ManufacturerName": "string", "Price": 0, "VatRate": 0, "ImageKey": "string", "UniqueName": "string", "CategoryId": 0, "PriceIncVat": 0 } ]

Search products light (v2)

Request

Quick search of products, only returns ProductId and Name.

Query
searchStringstringrequired

Free text search string. Minimum of 2 characters required.

statusSeedstringrequired

Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

assortmentSeedstringrequired

Accepts a comma separated string of Assortment internal ids. Lookup references in ListAssortments.

pricelistSeedstring

A comma separated list of PriceList IDs to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

customerIdstring

Current Customer.Id, checks for specific customer bound prices.

companyIdstring

Current Company ID, checks for specific company bound prices.

sizestring

Number of items to display.

cultureCodestring

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

currencyIdstring

Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

salesAreaIdstring

Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

curl -i -X GET \
  'https://demo.storm.io/api/1.1/ProductService.svc/rest/SearchProductsLite2?assortmentSeed=string&searchString=string&statusSeed=string'

Responses

Success

BodyArray [
Idinteger(int32)

Internal product id.

Namestring

MaxLength: 255.

ManufacturerNamestring

MaxLength: 100.

Pricenumber(decimal)

The best price excluding VAT for the product.

VatRatenumber(decimal)

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

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.

UniqueNamestring

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

CategoryIdinteger or null(int32)
PriceIncVatnumber(decimal)

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

]
Response
[ { "Id": 0, "Name": "string", "ManufacturerName": "string", "Price": 0, "VatRate": 0, "ImageKey": "string", "UniqueName": "string", "CategoryId": 0, "PriceIncVat": 0 } ]

Update product view count

Request

Updates the view count for the product. Used when calculating most popular products. Should be called on product detail pages.

Query
categoryIdinteger(int32)required

The category internal id for the product.

productIdinteger(int32)required

Product internal id.

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

Responses

Success

Body

Promotions

Operations

Relations

Operations

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations