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

ParametricMultipleCultureModel

CultureCodestring or null[ 0 .. 16 ] characters

The culture code, e.g. "sv-SE" or "en-US".

Valuestring or null[ 0 .. 255 ] characters

The display value for the parametric multiple item in the specific language.

IsValueInheritedboolean

Indicates whether the parametric multiple item value is inherited from the default language.

Descriptionstring or null

The parametric multiple item description in the specific language. No size limit.

IsDescriptionInheritedboolean

Indicates whether the parametric multiple item description is inherited from the default language.

IsTranslatedboolean

Indicates whether any of the fields have been translated for this culture.

{ "CultureCode": "string", "Value": "string", "IsValueInherited": true, "Description": "string", "IsDescriptionInherited": true, "IsTranslated": true }

ParametricMultipleModel

Parametric Multiple model, represents a predefined multiple selection list of values for a parametric attribute. Used when the parametric type is set to "multiple".

Idinteger(int32)

Internal identifier for the parametric multiple item. Client-specific.

Example: 1
ParametricIdinteger(int32)required

The identifier of the parametric this multiple item belongs to.

Example: 6
Valuestring or null[ 0 .. 255 ] characters

The display value for the parametric multiple item in a specific language.

Example: "Do not dry clean"
DefaultValuestring or null[ 0 .. 255 ] characters

The display value for the parametric multiple item in the default language.

Example: "Do not dry clean"
IsValueInheritedboolean

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

Descriptionstring or null

A longer description for the parametric multiple item in a specific language. No size limit.

DefaultDescriptionstring or null

A longer description for the parametric multiple item in the default language. No size limit.

IsDescriptionInheritedboolean

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

SortOrderinteger or null(int32)

Sort order for displaying the parametric multiple item in lists. If null, no specific order is defined.

Codestring or null[ 0 .. 50 ] characters

Unique code identifier for the parametric multiple item.

Example: "donotdryclean"
ImageKeystring or null(uuid)

Unique blob identifier for an associated image.

ImageUrlstring or null[ 0 .. 255 ] characters

Deprecated, URL path to an associated image for the parametric multiple item.

IsActivebooleanrequired

False if the parametric multiple item is soft deleted, removes it from selection lists but easily reactivatable.

Example: true
Changedstring or null

The date and time when the parametric multiple item was last changed.

Example: "03/05/2024 14:07"
ChangedBystring or null

The name of the user who last changed the parametric multiple item, null if never changed.

CulturesArray of objects(ParametricMultipleCultureModel)

List of all culture-specific text fields for the parametric multiple item.

Example: [{"CultureCode":"en-GB","Value":"Do not dry clean","IsValueInherited":false,"Description":"","IsDescriptionInherited":false,"IsTranslated":true},{"CultureCode":"sv-SE","Value":null,"IsValueInherited":true,"Description":null,"IsDescriptionInherited":true,"IsTranslated":false}]
{ "Id": 1, "ParametricId": 6, "Value": "Do not dry clean", "DefaultValue": "Do not dry clean", "IsValueInherited": false, "Description": "", "DefaultDescription": "", "IsDescriptionInherited": false, "SortOrder": null, "Code": "donotdryclean", "ImageKey": null, "ImageUrl": "", "IsActive": true, "Changed": "03/05/2024 14:07", "ChangedBy": null, "Cultures": [ {}, {} ] }

PriceListModel

PriceList model, represents a price list with its configuration and rules. Price lists define pricing and assortments for clients.

Idinteger(int32)

The unique identifier of the price list

PriceListIdinteger(int32)

The price list identifier

Namestring or null[ 0 .. 50 ] characters

The name of the price list

Descriptionstring or null

The description of the price list

Codestring or null[ 0 .. 50 ] characters

The agreement code for the price list

ImageKeystring or null(uuid)

The unique key identifier for the price list image, not normally used.

ImageUrlstring or null[ 0 .. 255 ] characters

The URL path to the price list image, deprecated, not normally used.

TypeIdinteger(int32)

The type identifier of the price list

TypeNamestring or null

The name of the price list type

PriceRuleNamestring or null

The name of the default price rule associated with this price list

StartDatestring or null(date-time)

The start date when the price list becomes active

EndDatestring or null(date-time)

The end date when the price list becomes inactive

CurrencyIdinteger(int32)

The identifier for the currency the price list uses

CurrencyCodestring or null

The currency code for the currency the price list uses

CurrencyNamestring or null

The name of the currency used in the price list

SalesAreaIdinteger or null(int32)

The sales area identifier associated with this price list, if null, no specific sales area is assigned and is usually inherited from the application it is connected to or from the primary sales area of the client. This is primarily used for rounding rules, where rounding is calculated on the including VAT sale price.

SalesAreaNamestring or null

The name of the sales area associated with this price list

SalesAreaIdIsInheritedboolean

Indicates whether the sales area ID is inherited from parent

InheritedSalesAreaNamestring or null

The name of the inherited sales area, shows the current application sales area.

DefaultPriceRuleIdinteger or null(int32)

The default price rule identifier for this price list

DefaultPriceRuleValuenumber or null(double)

The value for the default price rule

DefaultSupplementChargePercentagenumber(double)

The default supplement charge percentage applied to products

DefaultSupplementChargenumber or null(double)

The default supplement charge amount applied to products

DefaultMinimumProductMarginPercentagenumber or null(double)

The default minimum product margin percentage

DefaultLimitToPriceRecommendedboolean or null

Indicates whether prices are limited to recommended prices

InheritStructureCalculationRuleinteger(int32)

The rule for inheriting structure calculation settings

ParentPriceListIdinteger or null(int32)

The identifier of the parent price list for inheritance. If null, some price rules are not working.

ParentPriceListNamestring or null

The name of the parent price list

PopulationRuleIdinteger(int32)

The population rule identifier used for product population

PopulationRuleNamestring or null

The name of the population rule

ChosenWarehouseIdinteger or null(int32)

The chosen warehouse identifier for this price list. The primary warehouse that is used for stock checking and availability.

ChosenLocationIdinteger or null(int32)

The chosen location identifier for this price list. The primary location that is used for stock checking and availability. This is usually used as the location receiving stock reservation by Norce shopping logic.

IsPrimaryboolean

Indicates whether this is the primary price list for the current application.

IsPublicboolean

Indicates whether the price list has prices that is publicly accessible from the application.

IsNotStartedboolean

Indicates whether the price list has not started yet

IsEndedboolean

Indicates whether the price list has ended.

IsVirtualboolean

Indicates whether this is a virtual price list. Virtual price lists are calculated in real-time and do not store prices. Requires a parent price list that provide the base information and assortment.

IsLimitedToStockboolean or null

Indicates whether the price list is limited to available stock. Currently not functional.

IsFavoriteboolean

Indicates whether this price list is marked as favorite in the current application in the admin interface.

IsActiveboolean

Indicates whether the price list is currently active, note this may still be a price list that has not started or has ended.

Changedstring or null

The date and time when the price list was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the price list

{ "Id": 0, "PriceListId": 0, "Name": "string", "Description": "string", "Code": "string", "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c", "ImageUrl": "string", "TypeId": 0, "TypeName": "string", "PriceRuleName": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "CurrencyId": 0, "CurrencyCode": "string", "CurrencyName": "string", "SalesAreaId": 0, "SalesAreaName": "string", "SalesAreaIdIsInherited": true, "InheritedSalesAreaName": "string", "DefaultPriceRuleId": 0, "DefaultPriceRuleValue": 0.1, "DefaultSupplementChargePercentage": 0.1, "DefaultSupplementCharge": 0.1, "DefaultMinimumProductMarginPercentage": 0.1, "DefaultLimitToPriceRecommended": true, "InheritStructureCalculationRule": 0, "ParentPriceListId": 0, "ParentPriceListName": "string", "PopulationRuleId": 0, "PopulationRuleName": "string", "ChosenWarehouseId": 0, "ChosenLocationId": 0, "IsPrimary": true, "IsPublic": true, "IsNotStarted": true, "IsEnded": true, "IsVirtual": true, "IsLimitedToStock": true, "IsFavorite": true, "IsActive": true, "Changed": "string", "ChangedBy": "string" }