Management API (v1)

The Norce Management API lets you manage configurations and metadata on a client.

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/

Settings ApplicationCountry

Manage application countries

Operations

Settings ApplicationCulture

Manage application cultures

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

Category

Manage categories

Operations

CategoryParametric

Manage parametric categories

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

PriceList ClientPriceListType

Operations

Settings ClientSalesArea

Operations

Customer FlagGroup

Operations

Customer Flag

Operations

Customer InfoType

Operations

Product Family

Operations

Product File

Operations

Product Manufacturer

Operations

Parametric Group

Operations

Parametric List

Operations

Parametric Multiple

Operations

Parametric

Operations

PriceList Population

Operations

PriceList Pricing

Operations

PriceList

Operations

PriceList SupplierPriceList

Operations

PriceList PriceListType

Operations

PriceList Warehouse

Operations

Product FlagGroup

Operations

Product Flag

Operations

Product InfoType

Operations

Product Type

Operations

Promotion

Operations

Product RelationType

Operations

PriceList RoundingRule

Operations

Shopping InfoType

Operations

Store Application

Operations

Store PriceList

Operations

Store

Operations

Store Warehouse

Operations

Supplier PriceList

Operations

Supplier PriceListWarehouse

Operations

Supplier

Operations

Supplier Warehouse

Operations

Supplier WarehouseLocation

Operations

Product VariantGroup

Operations

Product WarehouseLocation

Operations

Product Warehouse

Operations

Schemas

CategoryModel

Category model, represents a product category used to group products together in a hierarchy, with support for localized names and descriptions, default values for its products, vat codes (per sales area), and various other settings. The Category contains a list of CategoryCulture models for each localized properties.

Idinteger(int32)

Internal identifier for the category. Client-specific.

Namestring or null[ 0 .. 50 ] characters

The category name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The category name for the default language.

IsNameInheritedboolean

If true, the specific language doesn't have its own name and instead inherits from the default name.

Descriptionstring or null

A longer description for the category.

DefaultDescriptionstring or null

The category description in the default language.

IsDescriptionInheritedboolean

If true, the description is inherited from the default language rather than being its own text.

FullNamestring or null[ 0 .. 500 ] characters

Concatenated category name based on hierarchy. Format: root category - branch category - leaf category (for three levels).

DefaultFullNamestring or null[ 0 .. 500 ] characters

The full name in the default language.

IsFullNameInheritedboolean

If true, the full name is inherited from the default language rather than being its own text.

ParentIdinteger or null(int32)

The parent category's ID. Set this when placing a new category in the hierarchy.

ParentCodestring or null

The parent category code. You don't have to set this when setting ParentId.

ParentNamestring or null

The parent category name. You don't have to set this when setting ParentId.

SortOrderinteger(int32)

Decides where the category is positioned relative to other categories at the same level under the same parent.

IsDisplayOnlyboolean

Deprecated property with no specific function anymore.

ImageKeystring or null(uuid)

Image code from Norce image store for a category image. Not commonly used anymore.

ImageUrlstring or null[ 0 .. 255 ] characters

Full image URL with CDN host.

Codestring or null[ 0 .. 50 ] characters

Category code with string length of 50. Important to set and should be unique in the category tree.

Synonymsstring or null[ 0 .. 500 ] characters

Comma-separated list of phrases or words that can be indexed in the search functionality.

DefaultSynonymsstring or null[ 0 .. 500 ] characters

Synonyms in the default language.

IsSynonymsInheritedboolean

If true, the synonyms are inherited from the default language rather than being its own text.

UnspcCodestring or null[ 0 .. 50 ] characters

Code field for storing global classification system according to UNSPSC standard.

BusinessAreastring or null[ 0 .. 50 ] characters

Code field that can be used for business area classification.

CommodityCodestring or null[ 0 .. 50 ] characters

Code field for commodity classification.

IntegrationPartNostring or null[ 0 .. 50 ] characters

External identifier for all products in the category. Optional field used to identify all products in one category in other systems.

GrossWeightnumber or null(double)

Default gross weight value for all products in the category.

VatCodeIdinteger(int32)

Default VAT code for the current sales area (from the application) for all products in the category.

InheritedVatCodeIdinteger(int32)

default VAT code from the sales area.

IsVatCodeIdInheritedboolean

true if the VAT code is inherited from the sales area settings.

InheritedVatCodeNamestring or null

VAT code name for the inherited VAT code.

VatCodeIdInheritedFromstring or null

Explains where the VAT code is inherited from. Can be from the client setting or from the Norce default settings.

VatCodeNamestring or null

VAT code name for the current sales area.

VatCodeValuenumber(double)

VAT code value for the current sales area. 25.00 means 25% VAT.

InheritedVatCodeValuenumber(double)

VAT code value for the inherited VAT code. 25.00 means 25% VAT.

VatCodesArray of objects(SalesAreaVatCodeModel)

Different VAT codes for each sales area. If a client sales area is missing, the VAT code is inherited from client settings.

UnitOfMeasurementIdinteger or null(int32)

Default unit of measurement ID for all products in the category. Possible values: 1 (pcs), 2 (h), 3 (kg), 4 (l), 5 (pairs), 6 (sqm), 7 (m), 8 (boxes), 9 (rolls)

RecommendedSalesQtynumber or null(double)

Default recommended sales quantity for all products in the category.

IsReturnableboolean or null

Default value indicating whether products in the category are returnable.

IsDropShipOnlyboolean or null

Marks the products for dropshipping from the supplier directly.

CompetitivePricingMinPercentagenumber or null(double)

Default minimum margin on competitor pricing rules for products in the category. Should only be used if competitor pricing is activated.

CompetitivePricingTargetPercentagenumber or null(double)

Default target margin on competitor pricing rules for products in the category. Should only be used if competitor pricing is activated.

HideInTopListboolean

Removes the products from popularity and other top list functionality in Norce.

StockDisplayBreakPointinteger or null(int32)

Availability threshold used for specific delivery promises at low stock levels.

IsRecommendedQtyFixedboolean or null

Flag that forces Norce to set order quantities as multiples of the recommended sales quantity.

IsRecurringOrderableboolean or null

Flag marking products or whole categories as recurring products that can be bought in subscriptions.

IsActiveboolean

False if the category is soft deleted, making it hidden and non-functional but easily reactivatable.

Changedstring or null

The date and time when the Category entity was last changed

ChangedBystring or null

The name of the user who last changed the Category entity, null if never changed

CulturesArray of objects(CategoryCultureModel)

List of all culture-specific text fields for the category.

{ "Id": 0, "Name": "string", "DefaultName": "string", "IsNameInherited": true, "Description": "string", "DefaultDescription": "string", "IsDescriptionInherited": true, "FullName": "string", "DefaultFullName": "string", "IsFullNameInherited": true, "ParentId": 0, "ParentCode": "string", "ParentName": "string", "SortOrder": 0, "IsDisplayOnly": true, "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c", "ImageUrl": "string", "Code": "string", "Synonyms": "string", "DefaultSynonyms": "string", "IsSynonymsInherited": true, "UnspcCode": "string", "BusinessArea": "string", "CommodityCode": "string", "IntegrationPartNo": "string", "GrossWeight": 0.1, "VatCodeId": 0, "InheritedVatCodeId": 0, "IsVatCodeIdInherited": true, "InheritedVatCodeName": "string", "VatCodeIdInheritedFrom": "string", "VatCodeName": "string", "VatCodeValue": 0.1, "InheritedVatCodeValue": 0.1, "VatCodes": [ {} ], "UnitOfMeasurementId": 0, "RecommendedSalesQty": 0.1, "IsReturnable": true, "IsDropShipOnly": true, "CompetitivePricingMinPercentage": 0.1, "CompetitivePricingTargetPercentage": 0.1, "HideInTopList": true, "StockDisplayBreakPoint": 0, "IsRecommendedQtyFixed": true, "IsRecurringOrderable": true, "IsActive": true, "Changed": "string", "ChangedBy": "string", "Cultures": [ {} ] }

CategoryParametricModel

Category Parametric model, represents the association of a parametric attribute to a specific category, including settings that define how the parametric behaves within that category.

Idinteger(int32)required

The parametric identifier.

Example: 15
CategoryIdinteger or null(int32)

The category identifier this parametric is associated with.

Example: 11
Namestring or null[ 0 .. 50 ] characters

The parametric name.

Example: "Machines - Cutting size"
Codestring or null[ 0 .. 50 ] characters

The parametric code.

Example: "p_machines_cutting_size"
Uomstring or null[ 0 .. 50 ] characters

Unit of measurement for the parametric value.

Descriptionstring or null[ 0 .. 500 ] characters

A longer description for the parametric explaining it in more detail.

Typestring or null

The type of parametric. Valid values: text, html, int, decimal, date, boolean, list, multiple.

Example: "list"
TypeIdinteger(int32)

Obsolete, use Type property instead.

GroupIdinteger or null(int32)

The identifier of the parametric group this parametric belongs to. This can be the default group from the parametric definition or a specific group assigned for this category.

Example: 1
GroupNamestring or null[ 0 .. 50 ] characters

The name of the parametric group this parametric belongs to.

Example: "Specifications"
GroupDescriptionstring or null[ 0 .. 500 ] characters

The description of the parametric group this parametric belongs to.

Example: "Group of important specifications"
SortOrderinteger or null(int32)

The sort order for this parametric within the category.

Example: 1
FocusSortOrderinteger or null(int32)

The filter sort order for this parametric. Has value if the parametric is promoted to a filter in the category.

Example: 1
PrioritySortOrderinteger or null(int32)

Obsolete, not used anymore.

IsSecondaryboolean

Indicates whether this parametric is marked as secondary within the category. Used in front-end displays to de-emphasize less important attributes.

IsRequiredboolean or null

Indicates whether this parametric is required when assigned to products in this category. Overrides the global parametric setting if specified.

IsHiddenboolean

Indicates whether this parametric is hidden. Used in front-end displays to completely hide the attribute from view.

IsPublicboolean

Inherited from Parametric, indicates whether this parametric is Global.

DefaultIsVariantUniqueboolean

Inherited from Parametric, Indicates that the parametric will default to variants when merging products in this category.

Example: true
HasListValuesboolean

Indicated if the parametric has list values (Type = list, and has at least one list value defined).

HasMultipleValuesboolean

Indicated if the parametric has multiple values (Type = multiple, and has at least one list value defined).

IsActiveboolean

False if the parametric link is soft deleted, Indicates whether this parametric association is active for the category.

Example: true
Changedstring or null

The date and time when the CategoryParametric entity was last changed.

Example: "04/14/2025 15:19"
ChangedBystring or null

The name of the user who last changed the CategoryParametric entity.

Example: "Admin User"
{ "Id": 15, "CategoryId": 11, "Name": "Machines - Cutting size", "Code": "p_machines_cutting_size", "Uom": "", "Description": "", "Type": "list", "TypeId": 0, "GroupId": 1, "GroupName": "Specifications", "GroupDescription": "Group of important specifications", "SortOrder": 1, "FocusSortOrder": 1, "PrioritySortOrder": null, "IsSecondary": false, "IsRequired": false, "IsHidden": false, "IsPublic": false, "DefaultIsVariantUnique": true, "HasListValues": false, "HasMultipleValues": false, "IsActive": true, "Changed": "04/14/2025 15:19", "ChangedBy": "Admin User" }

ClientAssortmentCultureModel

CultureCodestring or null

The culture code for this culture-specific information

Namestring or null

The culture-specific name of the client assortment

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

Descriptionstring or null

The culture-specific description of the client assortment

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

IsTranslatedboolean

Indicates whether this culture has been translated

EntityCultureIdNamestring or null

Gets the name of the entity culture identifier property

{ "CultureCode": "string", "Name": "string", "IsNameInherited": true, "Description": "string", "IsDescriptionInherited": true, "IsTranslated": true, "EntityCultureIdName": "string" }