MANAGEMENT API

ProductTypeModel

Management API (v1)

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

Download OpenAPI description

openapi.json

openapi.yaml

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

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

ProductTypeCultureModel

CultureCodestring or null[ 0 .. 16 ] characters

The culture code for this culture-specific information

IsTranslatedboolean

Indicates whether this culture has been translated

Namestring or null[ 0 .. 50 ] characters

The culture-specific name of the product type

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

Descriptionstring or null[ 0 .. 500 ] characters

The culture-specific description of the product type

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

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

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
}