Skip to content

Documentation ProductService (1.1)

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

Schemas

Schemas

ProductParametric

Namestring

MaxLength: 50.

Valuestring

MaxLength: max. Obsolete! - Use Value2 with Uom

Idinteger(int32)

Internal product parametric id.

ValueIdinteger or null(int32)

Parametric value internal id if the parametric type is single list value.

Descriptionstring
ValueDescriptionstring

MaxLength: max.

IsPrimaryboolean
ValueIdSeedstring

MaxLength: max.

Value2string

The parametric value, if not a ListValue or a MultiValue parametric. MaxLength: max.

Uomstring

The unit of measurement, if any. MaxLength: 50.

GroupIdinteger(int32)

Id of the parametric group.

GroupNamestring

Name of the parametric group. MaxLength: 50.

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

Codestring

An external application specific code use to identify this Parametric. MaxLength: 50.

IsHiddenboolean

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.

{ "Name": "string", "Value": "string", "Id": 0, "ValueId": 0, "Description": "string", "ValueDescription": "string", "IsPrimary": true, "ValueIdSeed": "string", "Value2": "string", "Uom": "string", "GroupId": 0, "GroupName": "string", "SortOrder": 0, "Code": "string", "IsHidden": true }

ProductPrice

Valuenumber(decimal)

The actual price value, excluding VAT. Multiply by VatRate to get the price inc VAT.

Recommendednumber or null(decimal)

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

Catalognumber or null(decimal)

The original price, if specified.

VatRatenumber(decimal)

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

PriceListIdinteger(int32)

The priceList id for the price. If multiple priceLists are available then the best (lowest) price will be used.

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.

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.

IsRecommendedQuantityFixedboolean

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

Standardnumber or null(decimal)

The standard price, excluding VAT, if specified.

ValueIncVatnumber(decimal)

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

{ "Value": 0, "Recommended": 0, "Catalog": 0, "VatRate": 0, "PriceListId": 0, "IsBuyable": true, "RecommendedQuantity": 0, "IsRecommendedQuantityFixed": true, "Standard": 0, "ValueIncVat": 0 }

ProductPriceQtyBreak

PartNostring

The part number for this product.

QtyBreaknumber(decimal)

The minimum quantity needed to purchase to receive the ProductPrice.

ProductPriceobject(ProductPrice)(ProductPrice)
{ "PartNo": "string", "QtyBreak": 0, "ProductPrice": { "Value": 0, "Recommended": 0, "Catalog": 0, "VatRate": 0, "PriceListId": 0, "IsBuyable": true, "RecommendedQuantity": 0, "IsRecommendedQuantityFixed": true, "Standard": 0, "ValueIncVat": 0 } }

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