Product Service schemas
The Products namespace is concerned with product catalog data. Products, Prices, Availability etc.
Assortments
No entities. See IdValue
Categories
Categories
Represents a Category from Norce's navigation structures. This is returned as a tree structure where each node has a list of children.
CategoryParametric
Represents a parametric defined for a Category.
| Id | integer <int32> The internal Id of the Parametric. |
| Name | string The internal Id of the Parametric. MaxLength: 50 |
| GroupId | integer <int32> The internal Id of the ParametricGroup. |
| GroupName | string The Name of the ParametricGroup. MaxLength: 50 |
| SortOrder | integer <int32> Use this to sort the parametric. The value is fetched from the category's sort order for the parametric values. |
| IsGlobal | boolean Indicates if the parametric is global. If it is set as global it exists on all products in all categories. |
Configurations
ConfigurationItem
Represents an Item much like any package item. ConfigurationItems contains groups of configurable items instead of fixed items.
| PartNo | string The PartNo of the ConfigurationItem. MaxLength: 50 |
Array of objects <ConfigurationItemGroup> (ConfigurationItemGroup) A list of ConfigurationItemGroups where each group contains selectable items. |
ConfigurationItemGroup
Represents a selectable Item in a ConfigurationItem. The group contains all selectable items for this group.
| Id | integer <int32> The internal Id of the ConfigurationItemGroup. |
| Name | string The Name of the ConfigurationItemGroup. MaxLength: 512 |
| IsOptional | boolean Indicates if any item from Items must be selected or not. |
| IsMultiSelection | boolean Indicates if more than one item in Items must be selected or not. |
| SortOrder | integer <int32> The SortOrder of the ConfigurationItemGroup within the ConfigurationItem. |
Array of objects <ConfigurationItemGroupItem> (ConfigurationItemGroupItem) A list of ConfigurationItemGroupItems where each item is a selectable product. |
ConfigurationItemGroupItem
Represents a selectable Item in a ConfigurationItemGroup, i.e a Product. The Item is what the user selects in the configuration.
| ProductId | integer <int32> The internal product id of the Product. |
| PartNo | string The PartNo of the Product. MaxLength: 50 |
| Name | string The Name of the Product. When Product is a VariantType, this will be the value of the variant parameter(s). MaxLength: 255 |
| Description | string The Description of the Product. MaxLength: max |
| SortOrder | integer <int32> The SortOrder of the Item within the group. |
| Quantity | number <decimal> The Quantity of the Item. |
| Price | number <decimal> The Price of the Item. |
| PriceListId | integer <int32> The internal pricelist id of the Item. |
| VatRate | number <decimal> A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25. |
| ImageKey | string 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. |
| UniqueName | string A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500 |
Families
Family
Grouping of products cross Categories. It can be use to group products that are related to each other only by name, i.e family.
| Id | integer <int32> The internal Id of the Family. |
| Name | string The Name of the Family. MaxLength: 50 |
| Description | string The Description of the Family. MaxLength: max |
| ImageKey | string 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. |
| Code | string The external Code of the Family. MaxLength: 50 |
Files
ProductFile
Files related to Product.
| Id | integer <int32> This is the file internal id and it defines the kind of file it is. Not to be confused with entity ids. Values are application specific and should be like 'Front image', 'Back image'. See ListFileTypeIds for possible values. |
| Type | integer <int32> This is the FileTypeId mapped from Storm's predefined types. Types maps to mime types. |
| Path | string MaxLength: max |
| Name | string This is the Name of the product file. MaxLength: 50 |
| Description | string This is the Description of the product file. MaxLength: max |
| Key | string or null <guid> A unique id for the file at our image server. Url for images are formed like http://[client specific CDN]/{Key}. Preset, height and width can be sent as parameters. |
| Extension | string This is the file type extension for the current file. Can be used to append after image key in url. MaxLength: 50 |
| Code | string This is the file's external Code. Can be use as is for grouping files if Id is not adequate. Or any other application specific purpose. MaxLength: 50 |
| SortOrder | integer or null <int32> This is the sortorder of the file within its file type Id. |
Filters
Filter
Used to render filter options for product lists. See FilterList and ListProductFilter methods for details.
| Name | string The Name of the filter. Available names are: catf, mfrf, flgf, ohf, prcf and parf. These are a short notation of the actual types. Used in filter specifications as filter name. MaxLength: 50 |
| Type | string The Type of the filter. Available types are: Category, Manufacturer, Flag, OnHand, Price and Parametric. MaxLength: 50 |
Array of objects <IFilterItem> (IFilterItem) A list of specific FilterItems for the Filter. The items are the actual values for each type of Filter. |
FilterBoolItem
Special FilterItem with a boolean value used for parametric filters. FilterBool can be rendered with a CheckBox in the Application. Ex. for filter within a parf filter: 'V123_1-1' when value parametric 123 should have a value of 1 (true).
| __type required | string |
| Id | string The internal Id of the Parametric. MaxLength: int |
| Name | string The Name of the Parametric. MaxLength: 255 |
| Count | integer <int32> A count of SKUs matched by the FilterItem. |
| FalseCount | integer <int32> A count of SKUs not matched by the FilterItem. |
| Description | string The Description of the Parametric. MaxLength: max |
| ImageKey | string 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. |
FilterItem
The actual value for the items property of Filter. Used as filter specification values. Selected values should be comma separated in a filter specification. Ex: 'catf|123,124'
| __type required | string |
| Id | string The internal Id of the Parametric. MaxLength: int |
| Name | string The Name of the Parametric. MaxLength: 255 |
| Count | integer <int32> A count of SKUs matched by the FilterItem. |
| FalseCount | integer <int32> A count of SKUs not matched by the FilterItem. |
| Description | string The Description of the Parametric. MaxLength: max |
| ImageKey | string 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. |
FilterListItem
Special FilterItem for parametric filters which have single select values. Ex. for filter: 'L123_456' when list value parametric 123 should have value id 456. Use '' or '!' to separate or:ed values: 'L123_456L123_457'
| __type required | string |
| Id | string The internal Id of the Parametric. MaxLength: int |
| Name | string The Name of the Parametric. MaxLength: 255 |
| Count | integer <int32> A count of SKUs matched by the FilterItem. |
| FalseCount | integer <int32> A count of SKUs not matched by the FilterItem. |
| Description | string The Description of the Parametric. MaxLength: max |
| ImageKey | string 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. |
FilterMultiItem
Special FilterItem for parametric filters which have multi select values. Ex. for filter: 'M123_456' when multi parametric 123 should have value id 456. Use '' or '!' to separate or:ed values: 'M123_456M123_457'.
| __type required | string |
| Id | string The internal Id of the Parametric. MaxLength: int |
| Name | string The Name of the Parametric. MaxLength: 255 |
| Count | integer <int32> A count of SKUs matched by the FilterItem. |
| FalseCount | integer <int32> A count of SKUs not matched by the FilterItem. |
| Description | string The Description of the Parametric. MaxLength: max |
| ImageKey | string 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. |
FilterPriceItem
Used as Item for filter type Price. FilterPriceItem can be rendered with a slide bar in the Application. Ex. for filter: 'prcf|true_10-20' when price should be between 10 to 20 inc vat.
| __type required | string |
| Id | string The internal Id of the Parametric. MaxLength: int |
| Name | string The Name of the Parametric. MaxLength: 255 |
| Count | integer <int32> A count of SKUs matched by the FilterItem. |
| FalseCount | integer <int32> A count of SKUs not matched by the FilterItem. |
| Description | string The Description of the Parametric. MaxLength: max |
| ImageKey | string 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. |
FilterRangeItem
Special FilterItem with a range defined by a min and max value for parametric filters. FilterRangeItems can be rendered with a slide bar in the Application. Ex. for filter: 'V123_1.4-2.5' when value parametric should be between 1.4 and 2.5.
| __type required | string |
| Id | string The internal Id of the Parametric. MaxLength: int |
| Name | string The Name of the Parametric. MaxLength: 255 |
| Count | integer <int32> A count of SKUs matched by the FilterItem. |
| FalseCount | integer <int32> A count of SKUs not matched by the FilterItem. |
| Description | string The Description of the Parametric. MaxLength: max |
| ImageKey | string 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. |
ProductItemFilterValues
| ProductId | integer <int32> Internal product id. |
| GroupByKey | string 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 |
| CategoryId | integer or null <int32> Internal category id. |
| ManufacturerId | integer or null <int32> Internal manufacturer id. |
| FlagIdSeed | string A comma separated list of flag internal ids. MaxLength: max |
| Price | number <decimal> Best price excluding VAT. |
| VatRate | number <decimal> A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25. |
object <OnHand> (OnHand) | |
object <OnHand> (OnHand) | |
object <OnHand> (OnHand) | |
| ParametricListSeed | string MaxLength: max |
| ParametricMultipleSeed | string MaxLength: max |
| ParametricValueSeed | string ParametricValueSeed contains a comma separated list of id-value pairs separated by colon. Ex: 4711:32,4712:5. Id is the ParametricId and Value is either a ListValueId, MultipleValueId or the actual value depending on the parametric type. Note that parametric values with string or html types are not included here since we cannot know if they contain any of the separators. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max |
Flags
Flag
Used in FlagList when returning product flags.
| Id | integer <int32> The internal Id of the Flag. |
| Name | string The Name of the Flag. MaxLength: 50 |
| TypeId | integer <int32> The Type of the Flag. ProductFlags have TypeId = 1 and VariantFlags have TypeId = 2. |
| GroupId | integer <int32> The GroupId of the Flag. This value is client specific and can be used to group product flags. |
| Description | string The Description of the Flag. MaxLength: 500 |
| Code | string The external Code for the flag. MaxLength: 500 |
FlagGroup
Used to group different flags together.
| Id | integer <int32> The internal Id of the flagGroup. |
| Name | string The Name of the flagGroup. MaxLength: 50 |
| Description | string The Description of the flagGroup. MaxLength: 500 |
| Code | string The external Code for the flagGroup. MaxLength: 500 |
InfoTypes
No entities. See IdNameDescriptions
Manufacturers
Manufacturer
Contains basic data about Manufacturers in Norce. It is returned from GetManufacturer.
| Id | integer <int32> The internal Id of the Manufacturer. |
| Name | string The Name of the Manufacturer. MaxLength: 100 |
| OrgNo | string The organizational number of the Manufacturer. MaxLength: 50 |
| WebSite | string The url to the Manufacturer's web site. MaxLength: 255 |
| LogoPath | string MaxLength: 255 |
| SupportUrl | string The url to the Manufacturer's support page on their web site. MaxLength: 255 |
| SupportEmail | string The email address to the Manufacturer's support. MaxLength: 255 |
| SupportPhone | string The phone number to the Manufacturer's support. MaxLength: 500 |
| SupportOpenHours | string The opening hours for the Manufacturer's support. MaxLength: max |
| SupportPolicy | string The url to the Manufacturer's support policy web page. MaxLength: max |
| SupportDescription | string The url to the Manufacturer's support description web page. MaxLength: max |
| Key | string <guid> The system wide unique Key of the Manufacturer. |
| LogoKey | string or null <guid> A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{LogoKey}. Preset, height and width can be sent as parameters. |
| UniqueName | string A unique name that can be used in Urls and to get this entity. GetManufacturer and GetManufacturerByUniqueName gets the same Manufacturer. MaxLength: 255 |
ManufacturerItem
Contains minimum data about Manufacturers in Norce shown in lists of Manufacturers. It is returned from ListManufacturer.
| Id | integer <int32> The internal Id of the Manufacturer. |
| Name | string The Name of the Manufacturer. MaxLength: 100 |
| Key | string <guid> The system wide unique Key of the Manufacturer. |
| ProductCount | integer <int32> |
| UniqueName | string A unique name that can be used in Urls and to get a Manufacturer. GetManufacturer and GetManufacturerByUniqueName gets the same Manufacturer. MaxLength: 255 |
| LogoKey | string or null <guid> A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{LogoKey}. Preset, height and width can be sent as parameters. |
ManufacturerItemPagedList
PagedList of ManufacturerItems. The Items property contains all current items, depending on paging, and the ItemCount the total number of items.
| ItemCount | integer <int32> The total item count. Can be used to manage paging. Use PageSize to calculate number of pages. |
Array of objects <ManufacturerItem> (ManufacturerItem) Current list of ManufacturerItems for the current page if paging is used. Otherwise all items will be in the list. |
ProductManufacturer
| Id | integer <int32> Internal id of manufacturer. |
| Name | string MaxLength: 255 |
| PartNo | string MaxLength: 50 |
| LogoPath | string MaxLength: 255 |
| LogoKey | string or null <guid> A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{LogoKey}. Preset, height and width can be sent as parameters. |
| UniqueName | string A unique name that can be used in Urls and to get a Manufacturer. GetManufacturer and GetManufacturerByUniqueName gets the same Manufacturer. MaxLength: 255 |
Navigation
NavigationNode
The current node in the navigation. This is used when navigation is specified in Norce. Will be deprecated in the future.
| Key | string <guid> Key is unique for the NavigationNode and used when listing the content displayed for the node. |
| Hierarchy | string Hierarchy represents the current navigation path within the NavigationNode structure. Hierarchy is used to get the sub nodes for current node. MaxLength: 4000 |
| TypeId | integer <int32> TypeId defines the content type of the NavigationNode. |
| Name | string The display name of the NavigationNode. MaxLength: 50 |
| TargetPath | string The target path, if any, for the NavigationNode. This can be a direct link to any page that defines the content for the node. Depending on TypeId. MaxLength: 500 |
| ManufacturerSeed | string The manufacturer seed, if any, for the NavigationNode. MaxLength: 255 |
| CategorySeed | string The category seed, if any, for the NavigationNode. MaxLength: 255 |
| FlagIdSeed | string A comma separated list of flag internal ids, if any, for the NavigationNode. MaxLength: 255 |
| ImageKey | string or null <guid> The image key for the first underlying category, if any. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters. |
| Description | string The description for the first underlying category, if any. MaxLength: max |
| ProductCount | integer or null <int32> A count of existing products under this node. It will have a value if fetched from an operation which calculates the value, null otherwise. |
NavigationStructure
The root structure used for navigating the site. One application can have more than one structure. This is used when navigation is specified in Norce. Will be deprecated in the future.
| Id | integer <int32> The internal Id is used to get the NavigationNodeList for this structure. |
| Name | string The Name of the NavigationStructure. MaxLength: 50 |
| Description | string The Description of the NavigationStructure. MaxLength: 500 |
| IsDefault | boolean Indicates if the NavigationStructure is a default structure or not. |
OnHand
OnHand
Information about OnHand for a given SKU. There are generally three different types of OnHand in Norce. One for the Web, one for the chosen supplier and one for any specified Store.
| Value | number <decimal> The aggregated value from all warehouses and locations in the current context (Web, Supplier or Store). |
| IncomingValue | number <decimal> The incoming quantity on the next delivery. |
| NextDeliveryDate | string or null <date-time> The next delivery data from supplier to client warehouse. |
| LeadtimeDayCount | integer or null <int32> The number of days it takes to ship from the supplier. |
| LastChecked | string or null <date-time> When onHand info was last checked. Null if never. |
| IsActive | boolean Indicate if the product is stocked in a store. |
| IsReturnable | boolean Indicate if the product is returnable in a store. |
Array of objects <IdValue> (IdValue) List of IdValues for the OnHand data for this sku warehouse location combination. This will always be null unless fetched with any of the ProductOnHand methods. |
ProductOnHand
An entity that represents the OnHand for a product/variant.
| ProductId | integer <int32> The product internal id for the current product/variant. If the entity is fetched by productId it will be that productId. If the product is fetched by partNo it will be the productId for that variant. |
Array of objects <Warehouse> (Warehouse) A list of warehouses with OnHand for the product. | |
| Variants | Array of objects <ProductOnHand> (ProductOnHand) An optional list of ProductOnHand for all variants if fetched by productId. Null when fetched for a variant or a basket. |
Parametric
ParametricGroup
Information about a ParametricGroup. A ParametricGroup can be used to group different parametrics together.
| Id | integer <int32> The internal Id of the parametricGroup. |
| Name | string The Name of the parametricGroup. MaxLength: 50 |
| Description | string The Description of the parametricGroup. MaxLength: 500 |
| Code | string The external Code for the parametricGroup. MaxLength: 500 |
ParametricInfo
Metadata for a Parametric. This data can be cached for lookup use.
| Id | integer <int32> The internal Id of the parametric. |
| Name | string The Name of the parametric. MaxLength: 50 |
| Type | string The Type of the parametric: ListValue, MultiValue or Value. |
| Description | string The Description of the parametric. MaxLength: 500 |
| Uom | string The unit of measurement of the values. MaxLength: 50 |
| IsVariantParametric | boolean Specifies if the current Parametric is for variants only (true) or for the common product (false). |
| ValueType | string The data type of the values for this parametric: Text, Integer, Decimal, Boolean, Html or Date. |
| Code | string An externally defined code use to identify this Parametric. MaxLength: 50 |
| IsHidden | boolean Indicates if the parametric is hidden or not. This can be used to hide parametrics that are only used in application logic. Only non-hidden parametrics should be displayed in the frontend. |
| IsGlobal | boolean Indicates if the parametric is global. If it is set as global it exists on all products in all categories. |
ParametricsSeed
| ListSeed | string A comma separated list of parametric values on the format id:value-id. Id is the parametric id and value id is the parametric value id. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max |
| MultipleSeed | string Same as for ParametricListSeed but any parametric can have multiple values. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max |
| ValueSeed | string Same as for ParametricListSeed but the value is inlined as id:value. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. Parametric with values of type html or text are not supported. MaxLength: max |
ParametricValue
Metadata for ParametricValues. This data can be cached for lookup use. Only information about ListValues and MultiValues are returned.
| Id | integer <int32> The internal Id of the parametric value. |
| Name | string The Name of the parametric value. MaxLength: 255 |
| Description | string The Description of the parametric value. MaxLength: max |
| Code | string An externally defined code use to identify this Parametric value. MaxLength: 50 |
| ImageKey | string 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. |
| Type | string MaxLength: 50 |
| SortOrder | integer <int32> Can be specified in Storm Admin for each parametric value. |
| ParametricId | integer <int32> The internal Id of the Parametric that contains this value. |
| ParametricCode | string An externally defined code use to identify this Parametric that contains this value. MaxLength: 50 |
ProductParametric
| Name | string MaxLength: 50 |
| Value | string MaxLength: max |
| Id | integer <int32> Internal product parametric id. |
| ValueId | integer or null <int32> Parametric value internal id if the parametric type is single list value. |
| Description | string |
| ValueDescription | string MaxLength: max |
| IsPrimary | boolean |
| ValueIdSeed | string MaxLength: max |
| Value2 | string The parametric value, if not a ListValue or a MultiValue parametric. MaxLength: max |
| Uom | string The unit of measurement, if any. MaxLength: 50 |
| GroupId | integer <int32> Id of the parametric group. |
| GroupName | string Name of the parametric group. MaxLength: 50 |
| SortOrder | integer <int32> Use this to sort the parametric. The value is fetched from the variant group type's sort order in the first place and then from the category's sort order for the parametric values. |
| Code | string An external application specific code use to identify this Parametric. MaxLength: 50 |
| IsHidden | boolean Indicates if the parametric is hidden or not. This can be used to hide parametrics that are only used in application logic. Only non-hidden parametrics should be displayed in the frontend. |
PriceLists
Pricelist
Information about a specific pricelist.
| Id | integer <int32> The internal Id of the pricelist. |
| Name | string The Name of the pricelist. MaxLength: 50 |
| Description | string The Description of the pricelist. MaxLength: max |
| Agreement | string External pricelist code usually known to the Erp-system. MaxLength: 50 |
object <ApplicationsCurrency> (ApplicationsCurrency) | |
| IsPrimary | boolean Specifies if this is the primary priceList or not. |
| IsPublic | boolean Specifies if this is a public priceList or not. Most application specific pricelists are public while customer specific are not. |
| IsLimitedToStock | boolean Specifies if this priceList is limited to stock or not. |
| IsBid | boolean Specifies if this is a bid pricelist or not. |
| ImageKey | string 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. |
| Type | integer <int32> Internal id representing the type of priceList. Types are client specific except for 0=None, which is the default or standard priceList type. See ListPriceListTypes for defined types. |
| StartDate | string or null <date-time> The StarDate for when the pricelist is valid, if any. |
| EndDate | string or null <date-time> The EndDate for when the pricelist is valid, if any. |
| IsVirtual | boolean Specifies if the pricelist is virtual or not. Virtual pricelists must be inherited from a parent pricelists, which cannot be virtual, and can have no population rules. Prices are not stored in Storm but calculated on the fly when needed. Rules can be specified but other properties are inherited from parent. |
Products
HistoricalBestPrice
| PartNo | string The part number for this product. MaxLength: 50 |
| PriceListId | integer <int32> The pricelist internal id for the price. |
| Price | number <decimal> The actual price value, excluding VAT. |
| PriceIncVat | number <decimal> The actual price value, including VAT. |
| VatRate | number <decimal> A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25. |
| Updated | string <date-time> Time when this price started to be best price. |
Product
| Id | integer <int32> Internal id of the product. |
| Name | string The name of the product. When Product is a VariantType, this will be the value of the variant parameter(s). MaxLength: 255 |
| Description | string Description of the product. MaxLength: max |
| PartNo | string 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 |
| SubHeader | string MaxLength: 25 |
object <ProductManufacturer> (ProductManufacturer) | |
| Image | string MaxLength: 255 |
| CampaignImage | string MaxLength: 255 |
| LargeImage | string MaxLength: 255 |
| ThumbnailImage | string MaxLength: 255 |
Array 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. | |
| FlagIdSeed | string 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 |
| Price | number <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. |
| PriceCatalog | number or null <decimal> The original price, if specified. Same rules apply as for Price if it is a Product or a Variant. |
| PriceRecommended | number 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. |
| PriceFreight | number or null <decimal> |
| PriceFreightVatRate | number or null <decimal> |
| VatRate | number <decimal> A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25. |
| RecommendedQuantity | number 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. |
object <OnHand> (OnHand) | |
object <OnHand> (OnHand) | |
object <OnHand> (OnHand) | |
| Variants | Array of objects <Product> (Product) A list of variants for this Product, if any. If the Product is itself a variant this will be empty. |
| PriceListId | integer <int32> |
| Key | string <guid> |
| Updated | string or null <date-time> |
| NavigationNodeKey | string or null <guid> |
| CategoryId | integer or null <int32> |
| CategoryName | string MaxLength: 50 |
| ImageKey | string 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. |
Array of objects <ProductParametric> (ProductParametric) A list of this product's parametric values. Only used on variants. | |
| StatusId | integer <int32> |
| MetaTags | string Meta tags for SEO optimization. MaxLength: max |
| MetaDescription | string Meta description for SEO optimization. MaxLength: max |
| VariantName | string The complete variant name of the product. MaxLength: 255 |
| DescriptionHeader | string DescriptionHeader for the product as specified in Storm Admin. MaxLength: 255 |
| UniqueName | string A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500 |
| StockDisplayBreakPoint | integer or null <int32> A value that can be used for display logic regarding OnHand. |
Array 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. | |
Array of objects <IdNameDescription> (IdNameDescription) A list of this product's families. | |
| IsBuyable | boolean 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. |
| SubDescription | string Sub description from Storm Admin. MaxLength: max |
| Uom | string Short unit of measurement from Storm Admin. MaxLength: 50 |
| UomCount | number or null <decimal> Unit of measurement count |
| EanCode | string This will be the EAN code of the selected variant of the product if any. Variants will have this set. MaxLength: 50 |
| Type | integer <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. |
Array of objects <IdValue> (IdValue) A list of categories ordered so the primary category is first. | |
| IsRecommendedQuantityFixed | boolean If this is set to true only multiples of RecommendedQuantity should be allowed. |
| PopularityRank | integer or null <int32> A value used to sort items based on popularity. Lower values are more popular. |
| CostPurchase | number or null <decimal> CostPurchase from Storm Admin. |
| CostUnit | number or null <decimal> CostUnit from Storm Admin. |
| Title | string Title for the product. As specified in Storm Admin. MaxLength: 255 |
| ActualWeight | number <decimal> Actual weight or gross weight for the product. As specified in Storm Admin. |
| CommodityCode | string Commodity code for the product. As specified in Storm Admin. |
| IsDropShipOnly | boolean True if this product is for drop ship only. False otherwise. |
| Synonyms | string Synonyms from the Product in Storm. Can be used when indexing the product in any search engine. MaxLength: 500 |
| IsSubscribable | boolean True if this product can be added to a Subscription. False otherwise. |
| UnspscCode | string United Nations Standard Products and Services Code for the product. MaxLength: 50 |
| PriceStandard | number or null <decimal> The standard price, if specified. Same rules apply as for Price if it is a Product or a Variant. |
| Width | number or null <decimal> The logistic width as defined in Storm. |
| Height | number or null <decimal> The logistic height as defined in Storm. |
| Depth | number or null <decimal> The logistic depth as defined in Storm. |
| IsDangerousGoods | boolean True if this product is considered as dangerous goods. False otherwise. |
| HasQuantityBreaks | boolean True if this product has any quantity breaks. False otherwise. |
| GroupByKey | string 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 |
| PriceIncVat | number <decimal> The price including VAT calculated on the server side. Should be used to display prices including VAT. |
ProductId
| Id | integer <int32> Internal product id. |
| Name | string MaxLength: 255 |
| ManufacturerName | string MaxLength: 100 |
| Price | number <decimal> The best price excluding VAT for the product. |
| VatRate | number <decimal> A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25. |
| ImageKey | string 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. |
| UniqueName | string A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500 |
| CategoryId | integer or null <int32> |
| PriceIncVat | number <decimal> The price including VAT calculated on the server side. Should be used to display prices including VAT. |
ProductItem
| Id | integer <int32> Internal product id. |
| Name | string MaxLength: 255 |
| SubHeader | string MaxLength: 255 |
object <ProductManufacturer> (ProductManufacturer) | |
| Image | string MaxLength: 255 |
| CampaignImage | string MaxLength: 255 |
| LargeImage | string MaxLength: 255 |
| ThumbnailImage | string MaxLength: 255 |
| FlagIdSeed | string A comma separated list of flag internal ids. MaxLength: max |
| Price | number <decimal> Best price calculated from available pricelists, excluding VAT. |
| PriceRecommended | number or null <decimal> The rule based price from a priceList, excluding VAT, if specified. |
| PriceCatalog | number or null <decimal> The original price, excluding VAT, if specified. |
| VatRate | number <decimal> A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25. |
| RecommendedQuantity | number 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. |
object <OnHand> (OnHand) | |
object <OnHand> (OnHand) | |
object <OnHand> (OnHand) | |
| Key | string <guid> |
| Updated | string or null <date-time> |
| ImageKey | string 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. |
| PopularityRank | integer or null <int32> A value used to sort items based on popularity. Lower values are more popular. |
| StatusId | integer <int32> |
| VariantName | string MaxLength: 255 |
| VariantImageKey | string or null <guid> |
| AdditionalImageKeySeed | string Seed formatted as TypeId[1]:Guid[1], TypeId[2]:Guid[2],.., TypeId[n]:Guid[n]. MaxLength: max |
| GroupByKey | string 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 |
| VariantFlagIdSeed | string A comma separated list of flag internal ids. Contains any variant specific flags when fetched in product list AsVariants. MaxLength: max |
| PartNo | string Contains the partNo if the product is not a variant. This will be empty if the product has variants. MaxLength: 50 |
| PriceListId | integer or null <int32> Contains the priceList internal id if the product is not a variant. This will be empty if the product has variants. |
| SortOrder | integer or null <int32> A custom sort order that can be used when the product item is in a list. The sort order is defined for the primary category of the product item. |
| CategoryId | integer or null <int32> |
| ParametricListSeed | string ParametricListSeed contains a comma separated list of id-value pairs separated by colon. Ex: 4711:32,4712:5. Id is the ParametricId and Value is a ListValueId. Note that parametric values with string or html types are not included here since we cannot know if they contain any of the separators. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max |
| ParametricMultipleSeed | string ParametricMultipleSeed contains a comma separated list of id-value pairs separated by colon. Ex: 4711:32,4712:5. Id is the ParametricId and Value is a MultipleValueId. Multiple values for the same parametric are repeated with the same id but different values. Note that parametric values with string or html types are not included here since we cannot know if they contain any of the separators. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max |
| ParametricValueSeed | string ParametricValueSeed contains a comma separated list of id-value pairs separated by colon. Ex: 4711:32,4712:5. Id is the ParametricId and Value is the actual value depending on the parametric type. Note that parametric values with string or html types are not included here since we cannot know if they contain any of the separators. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max |
Array of objects <IdValue> (IdValue) Global text parametrics configured to to appear in lists. | |
| VariantParametricSeed | string Contains all ParametricIds that distinguishes these variants for this product. Their specific values are found under ParametricListSeed, ParametricMultiSeed or ParametricValueSeed. Use ListParametricInfo to list all parametric info and ListParametricValues2 for all values as lookup when resolving parametric data. MaxLength: max |
| UniqueName | string A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500 |
| StockDisplayBreakPoint | integer or null <int32> A value that can be used for display logic regarding OnHand. |
| IsBuyable | boolean 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. |
| SubDescription | string Sub description from Storm Admin. MaxLength: max |
| Quantity | number or null <decimal> The Quantity, if applicable. Null otherwise. This value will be set when it makes sense such as for included items in StructuralItems. |
| Type | integer <int32> Sku type for this product. Might not be valid if there are variants with different types. Then variants must be examined. Also see ListSkutypes. |
| CategoryIdSeed | string A comma separated list of category internal ids ordered so the primary category id is first. MaxLength: max |
| IsRecommendedQuantityFixed | boolean If this is set to true only multiples of RecommendedQuantity should be allowed. |
| Synonyms | string Synonyms from the Product in Storm. Can be used when indexing the product in any search engine. MaxLength: 500 |
| VariantUniqueName | string A unique name that can be used in Urls and to get a Product. This is the variant's unique name. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500 |
| IsSubscribable | boolean True if this product can be added in a Subscription. False otherwise. |
| UnitOfMeasurement | string Short unit of measurement from Storm Admin. MaxLength: 50 |
| UnitOfMeasurementCount | number or null <decimal> Unit of measurement count |
| EanCode | string This will be the EAN code of the selected variant of the product if any. Variants will have this set. MaxLength: 50 |
| PriceStandard | number or null <decimal> The standard price, excluding VAT, if specified. |
| IsDangerousGoods | boolean True if this product is considered as dangerous goods. False otherwise. |
| PriceIncVat | number <decimal> The price including VAT calculated on the server side. Should be used to display prices including VAT. |
ProductItem2
| Id | integer <int32> The product internal id for this ProductItem2. |
| Key | string <guid> |
| Name | string MaxLength: 255 |
object <ProductManufacturer> (ProductManufacturer) | |
| CategoryIdSeed | string A comma separated list of category internal id ordered so the primary category id is first. MaxLength: max |
| PartNo | string Contains the part number of the primary Variant, adhering to manual sorting or if sorting isn't set - by lowest available price. MaxLength: 50 |
object <ProductPrice> (ProductPrice) | |
object <OnHand> (OnHand) | |
object <OnHand> (OnHand) | |
object <OnHand> (OnHand) | |
Array of objects <VariantItem> (VariantItem) The Variants on this ProductItem2. Use expand option Variants to include this property or it will be null. | |
| ImageKey | string 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. |
| AdditionalImageKeySeed | string Seed formatted as TypeId[1]:Guid[1], TypeId[2]:Guid[2],.., TypeId[n]:Guid[n]. MaxLength: max |
| FlagIdSeed | string A comma separated list of flag internal ids. MaxLength: max |
object <ParametricsSeed> (ParametricsSeed) | |
| UniqueName | string A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500 |
| SubHeader | string Sub header from the Product in Storm. MaxLength: 255 |
| SubDescription | string Sub description from the Product in Storm. MaxLength: max |
| Synonyms | string Synonyms from the Product in Storm. Can be used when indexing the product in any search engine. MaxLength: 500 |
| StockDisplayBreakPoint | integer or null <int32> A value that can be used for display logic regarding OnHand. |
| IsSubscribable | boolean True if this product can be added in a Subscription. False otherwise. |
| PopularityRank | integer or null <int32> A value used to sort items based on popularity. Lower values are more popular. |
| SortOrder | integer or null <int32> A custom sort order that can be used when the product item is in a list. The sort order is defined for the primary category of the product item. |
| Updated | string or null <date-time> |
ProductItem2PagedList
| ItemCount | integer <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. |
Array of objects <ProductItem2> (ProductItem2) |
ProductItemPagedList
| ItemCount | integer <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. |
Array of objects <ProductItem> (ProductItem) |
ProductPrice
| Value | number <decimal> The actual price value, excluding VAT. Multiply by VatRate to get the price inc VAT. |
| Recommended | number or null <decimal> The rule based price from a priceList, excluding VAT, if specified. |
| Catalog | number or null <decimal> The original price, if specified. |
| VatRate | number <decimal> A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25. |
| PriceListId | integer <int32> The priceList id for the price. If multiple priceLists are available then the best (lowest) price will be used. |
| IsBuyable | boolean 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. |
| RecommendedQuantity | number 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. |
| IsRecommendedQuantityFixed | boolean If this is set to true only multiples of RecommendedQuantity should be allowed. |
| Standard | number or null <decimal> The standard price, excluding VAT, if specified. |
| ValueIncVat | number <decimal> The actual price value including VAT calculated on the server side. Should be used to display prices including VAT. |
ProductPriceQtyBreak
Promotions
PromotionProducts
List of ProductItems per promotion and effect type.
| PromotionId | integer <int32> This is the promotion internal id for which the Products are listed. |
| EffectId | integer <int32> This is the effect internal id for which the Products are listed. |
Array of objects <ProductItem> (ProductItem) This is the list of Products associated with the promotion and effect. |
Relations
ProductAccessories
Obsolete, Use ProductRelations insteadobject <ProductItemPagedList> (ProductItemPagedList) | |
Array of objects <VariantAccessories> (VariantAccessories) This is a list of VariantAccessories. |
ProductRelations
| Id | integer <int32> This is the type internal id for the relation type |
| Code | string This is the type external code for the relation type |
| Name | string This is the name of the relation type |
| Description | string This is the description of the relation type |
Array of objects <RelationMetadataItem> (RelationMetadataItem) Indicates if the related items are product or variant specific | |
object <ProductItemPagedList> (ProductItemPagedList) | |
Array of objects <VariantRelations> (VariantRelations) This is a list of variant relations. |
RelationMetadataItem
| Id | integer <int32> This is the Storm internal product id. |
| PartNo | string This is the part number if variants are specified |
| IsVariantSpecific | boolean True if relation is to specific variants. |
Reviews
Review
The Review entity keeps track of customer reviews on products. It can be used to display a list of reviews on a product page. Other customers can like or dislike existing reviews.
| Id | integer or null <int32> The internal id of the review. Null or left out when creating new reviews. |
| ReferenceId | integer <int32> The internal product id of the review. Or if the review is for some other entity, then it is the entity Id. |
| Name | string The name of the reviewer. MaxLength: 255 |
string The email address of the reviewer. MaxLength: 255 | |
| Text | string The review text. MaxLength: max |
| Url | string A Url to some external source referenced by the reviewer. MaxLength: 255 |
| ImagePath | string A Url to some external image uploaded by the reviewer. MaxLength: 255 |
| Score | number <decimal> The review score, if scores are kept. It is up to the application to define the score range. |
| Date | string <date-time> The date of the review. |
| Likes | integer <int32> Number of likes. See UpdateProductReviewLikes for information about how to update this. |
| Dislikes | integer <int32> Number of dislikes. See UpdateProductReviewLikes for information about how to update this. |
| IsPublished | boolean or null Shows if review is published. Applications can have new reviews to not be published and later after internal review on the content have it published. |
SkuTypes
SkuType
Represents the type of a SKU.
| Id | integer <int32> The internal id of the sku type. |
| Name | string The name of the sku type. MaxLength: 255 |
| Description | string The description of the sku type. MaxLength: max |
| SortOrder | integer <int32> The sort order of the sku type. |
object <IdNameDescription> (IdNameDescription) |
Status
No entities. See IdValues
Variants
VariantAccessories
Obsolete, Use ProductRelations instead| Id | integer <int32> This is the product id for the variant. |
object <ProductItemPagedList> (ProductItemPagedList) |
VariantItem
| Id | integer <int32> The product internal id for this VariantItem. |
| GroupByKey | string A key that group items on product. It is equal to the product id for non-variants and equals 'v'+variantId for variants. Should be used to correlate ProductItems with VariantItems. MaxLength: int |
| Name | string The Name of this VariantItem. Will be the same as the corresponding product if this is not a Variant. MaxLength: 255 |
| StatusId | integer <int32> The status for this VariantItem. Valid values can be found in ListStatuses. |
| TypeId | integer <int32> The sku type for this VariantItem. Valid values can be found in ListSkutypes. |
| PartNo | string The partNo for this VariantItem. MaxLength: 50 |
| ManufacturerPartNo | string The manufacturer's partNo for this VariantItem. MaxLength: 50 |
| ImageKey | string 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. |
| FlagIdSeed | string A comma separated list of flag internal ids. MaxLength: max |
object <ProductPrice> (ProductPrice) | |
object <OnHand> (OnHand) | |
object <OnHand> (OnHand) | |
object <OnHand> (OnHand) | |
object <ParametricsSeed> (ParametricsSeed) | |
| AdditionalImageKeySeed | string Seed formatted as TypeId[1]:Guid[1], TypeId[2]:Guid[2],.., TypeId[n]:Guid[n]. MaxLength: max |
| EanCode | string The EAN code for this VariantItem. MaxLength: 50 |
| IsBuyable | boolean 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. |
| UnitOfMeasurement | string Short unit of measurement from Storm Admin. MaxLength: 50 |
| UnitOfMeasurementCount | number or null <decimal> Unit of measurement count |
| RecommendedQuantity | number 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. |
| IsRecommendedQuantityFixed | boolean If this is set to true only multiples of RecommendedQuantity should be allowed. |
| SubHeader | string Sub header from the Product in Storm. Only set if Product texts are variant unique. MaxLength: 255 |
| SubDescription | string Sub description from the Product in Storm. Only set if Product texts are variant unique. MaxLength: max |
VariantRelations
Variant specific relations for this product.
| Id | integer <int32> This is the product internal id for the variant |
Array of objects <RelationMetadataItem> (RelationMetadataItem) Indicates if the related items are product or variant specific | |
object <ProductItemPagedList> (ProductItemPagedList) |
Warehouses
Warehouse
Represents a Warehouse. Used to get detailed OnHand for a product/variant or basket.
| StoreId | integer or null <int32> The store internal id for the current store. Can be null if WarehouseId and LocationId are supplied. |
| WarehouseId | integer or null <int32> The internal id for the warehouse. Can be null if StoreId is supplied. |
| LocationId | integer or null <int32> The internal id for the warehouse location. Can be null if StoreId is supplied. |
object <OnHand> (OnHand) |
WarehouseInfo
Represents a Warehouse with Locations and an optional Store. Used to get detailed meta data for warehouses, locations and stores.
| Id | integer <int32> The internal Id for the warehouse. |
| Type | integer <int32> The Type internal id for the warehouse. 1 for the standard warehouse, 2 if it is for a store. |
| Code | string The external Code for the warehouse. MaxLength: 50 |
| Name | string The Name for the warehouse. MaxLength: 50 |
| IsStandard | boolean Indicates if the warehouse is standard or not. |
Array of objects <WarehouseInfoLocation> (WarehouseInfoLocation) LocationInfos for the warehouse. |
WarehouseInfoLocation
Represents a Location for a WarehouseInfo.
| Id | integer <int32> The internal Id for the location. |
| Code | string The external Code for the location. MaxLength: 50 |
| Name | string The Name for the location. MaxLength: 50 |
| IsStandard | boolean Indicates if the location is standard or not. |
Array of objects <WarehouseInfoStore> (WarehouseInfoStore) A list of Stores for this location, if any. |
WarehouseInfoStore
Represents an optional Store for a WarehouseInfo.
| Id | integer <int32> The internal Id for the store. |
| Code | string The external Code for the store. MaxLength: 50 |
| Name | string The Name for the store. MaxLength: 50 |