Skip to content
COMMERCE SERVICES
/
Product Service
/
/
Product

Documentation ProductService (1.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/product/1.1/

Schemas

Schemas

Pricelist

Idinteger(int32)

The internal Id of the pricelist.

Namestring

The Name of the pricelist. MaxLength: 50.

Descriptionstring

The Description of the pricelist. MaxLength: max.

Agreementstring

External pricelist code usually known to the Erp-system. MaxLength: 50.

Currencyobject(ApplicationsCurrency)(ApplicationsCurrency)
IsPrimaryboolean

Specifies if this is the primary priceList or not.

IsPublicboolean

Specifies if this is a public priceList or not. Most application specific pricelists are public while customer specific are not.

IsLimitedToStockboolean

Specifies if this priceList is limited to stock or not.

IsBidboolean

Specifies if this is a bid pricelist or not.

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.

Typeinteger(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.

StartDatestring or null(date-time)

The StarDate for when the pricelist is valid, if any.

EndDatestring or null(date-time)

The EndDate for when the pricelist is valid, if any.

IsVirtualboolean

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.

{
  "Id": 0,
  "Name": "string",
  "Description": "string",
  "Agreement": "string",
  "Currency": {
    "Id": 0,
    "Name": "string",
    "Code": "string",
    "Prefix": "string",
    "Suffix": "string"
  },
  "IsPrimary": true,
  "IsPublic": true,
  "IsLimitedToStock": true,
  "IsBid": true,
  "ImageKey": "string",
  "Type": 0,
  "StartDate": "2019-08-24T14:15:22Z",
  "EndDate": "2019-08-24T14:15:22Z",
  "IsVirtual": true
}

Product

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.

ImageAltTextstring

Default image alt text

{
  "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,
  "ImageAltText": "string"
}

ProductAccessories

Accessoriesobject(ProductItemPagedList)(ProductItemPagedList)
VariantAccessoriesArray of objects(VariantAccessories)(VariantAccessories)

This is a list of VariantAccessories.

{
  "Accessories": {
    "ItemCount": 0,
    "Items": [ … ]
  },
  "VariantAccessories": [
    { … }
  ]
}

Assortments

Operations

Categories

Operations

Configurations

Operations

Families

Operations

Files

Operations

Filters

Operations

Flags

Operations

InfoTypes

Operations

Manufacturers

Operations

OnHand

Operations

Parametric

Operations

PriceLists

Operations

Products

Operations

Promotions

Operations

Relations

Operations

Reviews

Operations

SkuTypes

Operations

Status

Operations

Variants

Operations

Warehouses

Operations