Norce Commerce Product v1.1 service (1.1)

The Product namespace has Entities and Operations used for Products and other related Entities such as Prices, Filters, Categories etc. The main use of the Product service is to retrieve product data, variants, prices, and its availability to be used in a webshop or other sales channels. The Product service is read only and does not support creating or updating data in Norce. For this, use the Connect API.

Download OpenAPI description
Languages
Servers
Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Assortments

Contains endpoints for viewing metadata about assortment types, not commonly used anymore, still in use by legacy systems.

Operations

Categories

Contains endpoints for looking up category metadata.

Operations

Configurations

Contains endpoints for working with configuration products, not currently in use.

Operations

Families

Contains endpoints for viewing product family metadata, not commonly used anymore, but still needed in legacy systems.

Operations

Files

Contains endpoints for viewing file and image metadata.

Operations

Filters

Contains endpoints for working with ProductFilter navigations. Read more about it here.

Operations

Flags

Contains endpoints for viewing product flag metadata.

Operations

InfoTypes

Contains endpoints for viewing product related extended fields, info types.

Operations

Manufacturers

Contains endpoints for viewing manufacturer information.

Operations

OnHand

Contains endpoints for looking up detailed availability information.

Operations

Parametric

Contains endpoints for viewing parametric meta data and parametric data used in comparison views.

Operations

PriceLists

Contains endpoints for viewing price list data and metadata.

Operations

Products

Contains endpoints for listing, finding and viewing products, variants and its content. Read more about this here and here

Operations

Promotions

Contains endpoints for listing products based on promotion associations.

Operations

Relations

Contains endpoints for listing products based on their relations and relation metadata.

Operations

Reviews

Contains endpoints for managing product reviews, not commonly used anymore, still in use by legacy systems.

Operations

SkuTypes

Contains endpoints for looking up product type metadata.

Operations

Status

Contains endpoints for looking up product status metadata.

Operations

Variants

Contains endpoints for listing variants.

Operations

Warehouses

Contains endpoints for viewing warehouse and location information.

Operations

Schemas

Pricelist

Information about a specific pricelist.

Idinteger or null(int32)

The internal Id of the pricelist.

Namestring or null

The Name of the pricelist.

Descriptionstring or null

The Description of the pricelist.

Agreementstring or null

External pricelist code usually known to the Erp-system.

Currencyobject or null

The Currency entity contains info about a currency.

IsPrimaryboolean or null

Specifies if this is the primary priceList or not.

IsPublicboolean or null

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

IsLimitedToStockboolean or null

Specifies if this priceList is limited to stock or not.

IsBidboolean or null

Specifies if this is a bid pricelist or not.

ImageKeystring or null(uuid)

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 or null(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 or null

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 Norce but calculated on the fly when needed. Rules can be specified but other properties are inherited from parent.

SalesAreaIdinteger or null(int32)

The internal Id of the SalesArea associated with this pricelist, if any.

SalesAreaNamestring or null

The Name of the SalesArea associated with this pricelist, if any.

{ "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": "9afa8b7e-ca15-438f-a9d6-f679c437e59c", "Type": 0, "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "IsVirtual": true, "SalesAreaId": 0, "SalesAreaName": "string" }

Product

Represents a Product in Norce and can have other Products under Variants if it has variants. Data on the Product level is general data that applies to all underlying variants, whereas data on Products under Variants is variant specific.

Idinteger or null(int32)

Internal id of the product.

Namestring or null[ 0 .. 255 ] characters

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

Descriptionstring or null

Description of the product.

PartNostring or null[ 0 .. 50 ] characters

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 or null
Manufacturerobject or null
FilesArray of objects or null(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 or null

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.

Pricenumber or null(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.

VatRatenumber or null(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 or null

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.

OnHandStoreobject or null

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.

OnHandSupplierobject or null

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.

VariantsArray of objects or null(Product)

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

PriceListIdinteger or null(int32)
Keystring or null(uuid)
Updatedstring or null(date-time)
NavigationNodeKeystring or null(uuid)
ImageKeystring or null(uuid)

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 or null(ProductParametric)

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

StatusIdinteger or null(int32)
MetaTagsstring or null

Meta tags for SEO optimization.

MetaDescriptionstring or null

Meta description for SEO optimization.

VariantNamestring or null[ 0 .. 255 ] characters

The complete variant name of the product. MaxLength: 255

DescriptionHeaderstring or null[ 0 .. 255 ] characters

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

UniqueNamestring or null[ 0 .. 500 ] characters

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 or null(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 or null(IdNameDescription)

A list of this product's families.

IsBuyableboolean or null

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 or null

Sub description from Norce Admin.

Uomstring or null[ 0 .. 50 ] characters

Short unit of measurement from Norce Admin. MaxLength: 50

UomCountnumber or null(decimal)

Unit of measurement count

EanCodestring or null[ 0 .. 50 ] characters

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

Typeinteger or null(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 or null(IdValue)

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

IsRecommendedQuantityFixedboolean or null

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 Norce Admin.

CostUnitnumber or null(decimal)

CostUnit from Norce Admin.

Titlestring or null[ 0 .. 255 ] characters

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

ActualWeightnumber or null(decimal)

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

CommodityCodestring or null

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

IsDropShipOnlyboolean or null

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

Synonymsstring or null[ 0 .. 500 ] characters

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

IsSubscribableboolean or null

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

UnspscCodestring or null[ 0 .. 50 ] characters

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

Heightnumber or null(decimal)

The logistic height as defined in Norce.

Depthnumber or null(decimal)

The logistic depth as defined in Norce.

IsDangerousGoodsboolean or null

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

HasQuantityBreaksboolean or null

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

GroupByKeystring or null

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 or null(decimal)

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

ImageAltTextstring or null

Default image alt text

Imagestring or nullDeprecated
CampaignImagestring or nullDeprecated
LargeImagestring or nullDeprecated
ThumbnailImagestring or nullDeprecated
PriceFreightnumber or null(decimal)Deprecated
PriceFreightVatRatenumber or null(decimal)Deprecated
CategoryIdinteger or null(int32)Deprecated
CategoryNamestring or nullDeprecated
{ "Id": 0, "Name": "string", "Description": "string", "PartNo": "string", "SubHeader": "string", "Manufacturer": { "Id": 0, "Name": "string", "PartNo": "string", "LogoPath": "string", "LogoKey": "3d7d7146-aca8-4108-aa6b-ef13bcb3846c", "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": "5eb041b0-19c9-4022-bd51-0e723885f5dd", "Updated": "2019-08-24T14:15:22Z", "NavigationNodeKey": "3262290d-6a4d-498f-832e-e20e1341c243", "CategoryId": 0, "CategoryName": "string", "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c", "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" }

ProductFile

Files related to Product.

Idinteger or null(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.

Typeinteger or null(int32)

This is the FileTypeId mapped from Norce's predefined types. Types maps to mime types.

Namestring or null

This is the Name of the product file.

Descriptionstring or null

This is the Description of the product file.

Keystring or null(uuid)

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.

Extensionstring or null

This is the file type extension for the current file. Can be used to append after image key in url.

Codestring or null

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.

SortOrderinteger or null(int32)

This is the sortorder of the file within its file type Id.

ImageAltTextstring or null

Image alt text

Pathstring or nullDeprecated
{ "Id": 0, "Type": 0, "Path": "string", "Name": "string", "Description": "string", "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd", "Extension": "string", "Code": "string", "SortOrder": 0, "ImageAltText": "string" }