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

ProductTypeModel

ProductType model, represents a built-in type of product that can be activated and renamed for a client. The type defines its products behavior in Norce´s business logic.

Idinteger(int32)

The product type identifier

Namestring or null[ 0 .. 50 ] characters

The display name of the product type in a specific language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the product type for the default language

Descriptionstring or null[ 0 .. 500 ] characters

The description of the product type in a specific language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the product type for the default language

GroupNamestring or null

The group name that categorizes the product type

SortOrderinteger(int32)

The sort order for displaying the product type in lists

Changedstring or null

The date and time the product type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the product type

CulturesArray of objects(ProductTypeCultureModel)

The culture-specific information for the product type

{ "Id": 0, "Name": "string", "IsNameInherited": true, "DefaultName": "string", "Description": "string", "IsDescriptionInherited": true, "DefaultDescription": "string", "GroupName": "string", "SortOrder": 0, "Changed": "string", "ChangedBy": "string", "Cultures": [ {} ] }

PromotionCultureModel

Culture-specific model for promotion translations

CultureCodestring or null[ 0 .. 16 ] characters

The culture code for this translation

Namestring or null[ 0 .. 255 ] characters

The name of the promotion in this culture

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

SubHeaderstring or null[ 0 .. 255 ] characters

The sub header of the promotion in this culture

IsSubHeaderInheritedboolean

Indicates whether the sub header is inherited from the default culture

SubDescriptionstring or null

The sub description of the promotion in this culture

IsSubDescriptionInheritedboolean

Indicates whether the sub description is inherited from the default culture

DescriptionHeaderstring or null[ 0 .. 255 ] characters

The description header of the promotion in this culture

IsDescriptionHeaderInheritedboolean

Indicates whether the description header is inherited from the default culture

Descriptionstring or null

The description of the promotion in this culture

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

IsTranslatedboolean

Indicates whether this culture has been translated

{ "CultureCode": "string", "Name": "string", "IsNameInherited": true, "SubHeader": "string", "IsSubHeaderInherited": true, "SubDescription": "string", "IsSubDescriptionInherited": true, "DescriptionHeader": "string", "IsDescriptionHeaderInherited": true, "Description": "string", "IsDescriptionInherited": true, "IsTranslated": true }

PromotionEffectProductListModel

PromotionEffectProductList model, represents a single product rule within a promotion effect setting. Defines specific product filters such as manufacturer, category, flag, price list, product type, product, or variant.

Idinteger(int32)

The unique identifier for the product effect rule

ManufacturerIdinteger or null(int32)

The manufacturer identifier for filtering products by manufacturer, null if not filtering by manufacturer

ManufacturerCodestring or null

The manufacturer code for filtering products by manufacturer, null if not filtering by manufacturer

ManufacturerNamestring or null

The manufacturer name for filtering products by manufacturer, null if not filtering by manufacturer

CategoryIdinteger or null(int32)

The category identifier for filtering products by category, null if not filtering by category

CategoryCodestring or null

The category code for filtering products by category, null if not filtering by category

CategoryNamestring or null

The category name for filtering products by category, null if not filtering by category

FlagIdinteger or null(int32)

The flag identifier for filtering products by flag, null if not filtering by flag

FlagCodestring or null

The flag code for filtering products by flag, null if not filtering by flag

FlagNamestring or null

The flag name for filtering products by flag, null if not filtering by flag

IsFlagInclusiveboolean

Indicates whether the flag rule is "set" or "not set" for filtering products by flag

PriceListIdinteger or null(int32)

The price list identifier for filtering products by price list, null if not filtering by price list

PriceListCodestring or null

The price list code for filtering products by price list, null if not filtering by price list

PriceListNamestring or null

The price list name for filtering products by price list, null if not filtering by price list

ProductTypeIdinteger or null(int32)

The product type identifier for filtering products by product type, null if not filtering by product type

ProductTypeNamestring or null

The product type name for filtering products by product type, null if not filtering by product type

ProductIdinteger or null(int32)

The product id filter for this product rule, null if not filtering by specific product

ProductHasVariantsboolean

True if the product has variants.

ProductNamestring or null

The product name for filtering by specific product, null if not filtering by specific product

VariantProductIdinteger or null(int32)

The variant product id filter for this product rule, null if not filtering by specific variant product

VariantProductNamestring or null

The variant product name for filtering by specific variant product, null if not filtering by specific variant product

PartNostring or null

The part number for the product or variant product

Qtyinteger or null(int32)

The quantity required for this product rule, null if applied on the requirement level

IsDiscountboolean or null

Indicates whether the effect is calculated as a percentage discount

IsFixedPriceboolean or null

Indicates whether the effect is a fixed price adjustment

Valuenumber or null(double)

The value associated with the effect, such as discount amount or fixed price

IsIncVatboolean or null

Indicates whether the value is inclusive of VAT, relevant for fixed price effects

Changedstring or null

The date and time when this promotion effect product list was last changed.

ChangedBystring or null

The identifier of the user who last changed this promotion effect product list.

{ "Id": 0, "ManufacturerId": 0, "ManufacturerCode": "string", "ManufacturerName": "string", "CategoryId": 0, "CategoryCode": "string", "CategoryName": "string", "FlagId": 0, "FlagCode": "string", "FlagName": "string", "IsFlagInclusive": true, "PriceListId": 0, "PriceListCode": "string", "PriceListName": "string", "ProductTypeId": 0, "ProductTypeName": "string", "ProductId": 0, "ProductHasVariants": true, "ProductName": "string", "VariantProductId": 0, "VariantProductName": "string", "PartNo": "string", "Qty": 0, "IsDiscount": true, "IsFixedPrice": true, "Value": 0.1, "IsIncVat": true, "Changed": "string", "ChangedBy": "string" }