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

ProductFlagGroup

Used to group different flags together.

Idinteger or null(int32)

The internal Id of the flagGroup.

Namestring or null

The Name of the flagGroup.

Descriptionstring or null

The Description of the flagGroup.

Codestring or null

The external Code for the flagGroup.

{ "Id": 0, "Name": "string", "Description": "string", "Code": "string" }

ProductId

Light weight product entity for lists.

Idinteger or null(int32)

Internal product id.

Namestring or null
ManufacturerNamestring or null
Pricenumber or null(decimal)

The best price excluding VAT for the product.

VatRatenumber or null(decimal)

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

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.

UniqueNamestring or null

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

CategoryIdinteger or null(int32)
PriceIncVatnumber or null(decimal)

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

{ "Id": 0, "Name": "string", "ManufacturerName": "string", "Price": 0, "VatRate": 0, "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c", "UniqueName": "string", "CategoryId": 0, "PriceIncVat": 0 }

ProductItem

Idinteger or null(int32)

Internal product id.

Namestring or null
SubHeaderstring or null
Manufacturerobject or null
FlagIdSeedstring or null

A comma separated list of flag internal ids.

Pricenumber or null(decimal)

Best price calculated from available pricelists, excluding VAT.

PriceRecommendednumber or null(decimal)

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

PriceCatalognumber or null(decimal)

The original price, excluding VAT, if specified.

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

Keystring or null(uuid)
Updatedstring or null(date-time)
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.

PopularityRankinteger or null(int32)

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

StatusIdinteger or null(int32)
VariantNamestring or null
VariantImageKeystring or null(uuid)
AdditionalImageKeySeedstring or null

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

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.

VariantFlagIdSeedstring or null

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

PartNostring or null

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

PriceListIdinteger or null(int32)

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

SortOrderinteger or null(int32)

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

ParametricListSeedstring or null

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.

ParametricMultipleSeedstring or null

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.

ParametricValueSeedstring or null

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.

ParametricTextFieldArray of objects or null(IdValue)

Global text parametrics configured to to appear in lists.

VariantParametricSeedstring or null

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.

UniqueNamestring or null

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

StockDisplayBreakPointinteger or null(int32)

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

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.

SubDescriptionstring or null

Sub description from Norce Admin.

Quantitynumber or null(decimal)

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

Typeinteger or null(int32)

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

CategoryIdSeedstring or null

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

IsRecommendedQuantityFixedboolean or null

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

Synonymsstring or null

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

VariantUniqueNamestring or null

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.

IsSubscribableboolean or null

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

UnitOfMeasurementstring or null

Short unit of measurement from Norce Admin.

UnitOfMeasurementCountnumber or null(decimal)

Unit of measurement count

EanCodestring or null

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

PriceStandardnumber or null(decimal)

The standard price, excluding VAT, if specified.

IsDangerousGoodsboolean or null

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

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

VariantImageAltTextstring or null

Variant image alt text

Imagestring or nullDeprecated
CampaignImagestring or nullDeprecated
LargeImagestring or nullDeprecated
ThumbnailImagestring or nullDeprecated
CategoryIdinteger or null(int32)Deprecated
{ "Id": 0, "Name": "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", "FlagIdSeed": "string", "Price": 0, "PriceRecommended": 0, "PriceCatalog": 0, "VatRate": 0, "RecommendedQuantity": 0, "OnHand": { "Value": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "LastChecked": "2019-08-24T14:15:22Z", "IsActive": true, "IsReturnable": true, "Info": [ … ] }, "OnHandStore": { "Value": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "LastChecked": "2019-08-24T14:15:22Z", "IsActive": true, "IsReturnable": true, "Info": [ … ] }, "OnHandSupplier": { "Value": 0, "IncomingValue": 0, "NextDeliveryDate": "2019-08-24T14:15:22Z", "LeadtimeDayCount": 0, "LastChecked": "2019-08-24T14:15:22Z", "IsActive": true, "IsReturnable": true, "Info": [ … ] }, "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd", "Updated": "2019-08-24T14:15:22Z", "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c", "PopularityRank": 0, "StatusId": 0, "VariantName": "string", "VariantImageKey": "dae7332e-2a6a-4175-bf5c-432c6c987f7e", "AdditionalImageKeySeed": "string", "GroupByKey": "string", "VariantFlagIdSeed": "string", "PartNo": "string", "PriceListId": 0, "SortOrder": 0, "CategoryId": 0, "ParametricListSeed": "string", "ParametricMultipleSeed": "string", "ParametricValueSeed": "string", "ParametricTextField": [ { … } ], "VariantParametricSeed": "string", "UniqueName": "string", "StockDisplayBreakPoint": 0, "IsBuyable": true, "SubDescription": "string", "Quantity": 0, "Type": 0, "CategoryIdSeed": "string", "IsRecommendedQuantityFixed": true, "Synonyms": "string", "VariantUniqueName": "string", "IsSubscribable": true, "UnitOfMeasurement": "string", "UnitOfMeasurementCount": 0, "EanCode": "string", "PriceStandard": 0, "IsDangerousGoods": true, "PriceIncVat": 0, "ImageAltText": "string", "VariantImageAltText": "string" }