MANAGEMENT API

VariantTypeModel

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

VariantTypeCultureModel

CultureCodestring or null[ 0 .. 16 ] characters

The culture code for this translation

IsTranslatedboolean

Indicates whether this culture has been translated

Namestring or null[ 0 .. 50 ] characters

The translated name of the variant type for this culture

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

Descriptionstring or null[ 0 .. 500 ] characters

The translated description of the variant type for this culture

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

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

VariantTypeModel

VariantType model (called simply parametrics in the admin interface when adding them to a variant group), represents types of variants that can be associated with products to define their variant structure. Each variant type can have culture-specific names and descriptions.

Idinteger(int32)

The variant type identifier

Namestring or null[ 0 .. 50 ] characters

The name of the variant type in the current culture

DefaultNamestring or null[ 0 .. 50 ] characters

The default name of the variant type

IsNameInheritedboolean

Indicates whether the name is inherited from the default culture

Descriptionstring or null[ 0 .. 500 ] characters

The description of the variant type in the current culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the variant type

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default culture

Codestring or null[ 0 .. 50 ] characters

The unique code identifier for the variant type, should be same as parametric code to keep consistency.

SortOrderinteger(int32)

The sort order of the variant type

IsActiveboolean

Indicates whether the variant type is active

ParametricIdinteger or null(int32)

The parametric identifier associated with this variant type

ParametricNamestring or null

The name of the parametric associated with this variant type

ParametricDescriptionstring or null

The description of the parametric associated with this variant type

Uomstring or null

The unit of measurement for the variant type

Typestring or null

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

Changedstring or null

The date and time when the variant type was last changed

ChangedBystring or null

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

CulturesArray of objects(VariantTypeCultureModel)

The list of culture-specific translations for this variant type

{
  "Id": 0,
  "Name": "string",
  "DefaultName": "string",
  "IsNameInherited": true,
  "Description": "string",
  "DefaultDescription": "string",
  "IsDescriptionInherited": true,
  "Code": "string",
  "SortOrder": 0,
  "IsActive": true,
  "ParametricId": 0,
  "ParametricName": "string",
  "ParametricDescription": "string",
  "Uom": "string",
  "Type": "string",
  "Changed": "string",
  "ChangedBy": "string",
  "Cultures": [
    { … }
  ]
}

WarehouseLocationModel

WarehouseLocation model, represents a specific location within a warehouse. Each location can have unique attributes such as code, name, and whether it is the standard location for the warehouse. It can also override lead times and stock calculation settings from the warehouse.

Idinteger(int32)

The warehouse location identifier

Codestring or null

The warehouse location code, must be unique within the warehouse

Namestring or null[ 0 .. 50 ] characters

The name of the warehouse location

IsStandardboolean

Indicates whether this is the standard location for the warehouse, only one location can be marked as standard per warehouse.

StandardLeadTimeDayCountinteger or null(int32)

The standard lead time commonly in days for this warehouse location, overrides warehouse setting if specified

IsIncludedInStockCalculationboolean

Indicates whether this location is included in stock calculations. Set to false if the location is used for display only and should not affect business logic.

PrimaryPriceListIdinteger(int32)

The primary price list identifier for this warehouse location

PrimaryPriceListNamestring or null

The name of the primary price list for this warehouse location

Changedstring or null

The date and time when the warehouse location was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the warehouse location

{
  "Id": 0,
  "Code": "string",
  "Name": "string",
  "IsStandard": true,
  "StandardLeadTimeDayCount": 0,
  "IsIncludedInStockCalculation": true,
  "PrimaryPriceListId": 0,
  "PrimaryPriceListName": "string",
  "Changed": "string",
  "ChangedBy": "string"
}