Management API (v1)

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

Download OpenAPI description
Languages
Servers

https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Schemas

ProductFlagModel

ProductFlag model, represents a flag that can be assigned to products to denote specific attributes or characteristics. Flags are organized into groups for better context and management. They can have culture-specific names and descriptions. Product flags can be utilized in various business logic scenarios, such as filtering products or applying specific pricing or promotion rules.

Idinteger(int32)

Internal identifier for the product flag. Client-specific.

TypeIdinteger(int32)required

The type identifier for the product flag. Allowed values are: 1= Product flag, 2 = Variant flag

GroupIdinteger(int32)required

The identifier of the group this product flag belongs to.

GroupNamestring or null

The name of the group this product flag belongs to.

Codestring[ 0 .. 50 ] charactersrequired

External reference code for the product flag, used for integration purposes.

Namestring or null[ 0 .. 50 ] characters

The product flag name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

The product flag 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[ 0 .. 500 ] characters

A longer description for the product flag explaining it in more detail.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The product flag description in the default language.

IsDescriptionInheritedboolean

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

IsManuallyEditableboolean

Indicates whether this flag can be manually edited by users in the admin interface.

SortOrderinteger or null(int32)

The sort order for displaying this flag in lists and interfaces.

IsActiveboolean

False if the product flag is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

Changedstring or null(date-time)

The date and time when the product flag entity was last changed.

ChangedBystring or null

The name of the user who last changed the product flag entity, null if never changed.

CulturesArray of objects(ProductFlagCultureModel)

List of all culture-specific text fields for the product flag.

{ "Id": 0, "TypeId": 0, "GroupId": 0, "GroupName": "string", "Code": "string", "Name": "string", "DefaultName": "string", "IsNameInherited": true, "Description": "string", "DefaultDescription": "string", "IsDescriptionInherited": true, "IsManuallyEditable": true, "SortOrder": 0, "IsActive": true, "Changed": "2019-08-24T14:15:22Z", "ChangedBy": "string", "Cultures": [ {} ] }

ProductFlagCultureModel

CultureCodestring or null[ 0 .. 16 ] characters

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

IsTranslatedboolean

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

Namestring or null[ 0 .. 50 ] characters

The product flag name in the specific language.

IsNameInheritedboolean

Indicates whether the product flag name is inherited from the default language.

Descriptionstring or null[ 0 .. 500 ] characters

The product flag description in the specific language.

IsDescriptionInheritedboolean

Indicates whether the product flag description is inherited from the default language.

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

ProductInfoTypeModel

ProductInfoType model, represents extendable fields to product entities like price records or onhand records. These fields can store additional information about these records, such as additional price information or logistic peculiarities, enhancing product data management.

Idinteger(int32)

The product info type identifier

GroupIdinteger(int32)

The group identifier that categorizes the info type, allowed values are: 2 = Onhand info types, 3 = Price info types

Codestring or null[ 0 .. 50 ] characters

The unique code of the info type, needed to identify the info type in connect api imports.

Namestring or null

The display name of the info type in a specific language

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the info type for the default language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null

The description of the info type in a specific language

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the info type for the default language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

SortOrderinteger(int32)

The sort order for displaying the info type in lists

IsActiveboolean

Indicates whether the info type is active

Changedstring or null

The date and time the info type was last changed

ChangedBystring or null

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

CulturesArray of objects(ProductInfoTypeCultureModel)

The culture-specific information for the info type

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

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

Category

Operations

CategoryParametric

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

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