ParametricGroupCultureModel

Management API (v1)

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

Download OpenAPI description

openapi.json

openapi.yaml

Servers

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

Schemas

ParametricGroupModel

Parametric Group model, represents a grouping of parametric attributes that can be assigned to categories and by extension products. Groups are either assigned as default group to parametrics or as assigned to category parametrics relationships.

Idinteger(int32)

Internal identifier for the parametric group. Client-specific.

Example: 5

Namestring or null[ 0 .. 50 ] characters

The parametric group name in a specific language.

Example: "Characteristics"

DefaultNamestring or null[ 0 .. 50 ] characters

The parametric group name for the default language.

Example: "Characteristics"

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 parametric group explaining it in more detail.

Example: "Common characteristics"

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The parametric group description in the default language.

Example: "Common characteristics"

IsDescriptionInheritedboolean

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

IsActiveboolean

False if the parametric group is soft deleted, making it hidden and non-functional but easily reactivatable.

Example: true

Codestring or null[ 0 .. 50 ] characters

Parametric group code with string length of 50. Important to set and should be unique across all parametric groups.

Example: "pg_characteristics"

Changedstring or null

The date and time when the ParametricGroup entity was last changed.

Example: "06/08/2024 14:40"

ChangedBystring or null

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

Example: "Admin user"

CulturesArray of objects(ParametricGroupCultureModel)

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

Example: [{"CultureCode":"en-GB","Name":"Characteristics","IsNameInherited":false,"Description":"Common characteristics","IsDescriptionInherited":false,"IsTranslated":true},{"CultureCode":"nb-NO","Name":null,"IsNameInherited":true,"Description":null,"IsDescriptionInherited":true,"IsTranslated":false},{"CultureCode":"sv-SE","Name":null,"IsNameInherited":true,"Description":null,"IsDescriptionInherited":true,"IsTranslated":false}]

{
  "Id": 5,
  "Name": "Characteristics",
  "DefaultName": "Characteristics",
  "IsNameInherited": false,
  "Description": "Common characteristics",
  "DefaultDescription": "Common characteristics",
  "IsDescriptionInherited": false,
  "IsActive": true,
  "Code": "pg_characteristics",
  "Changed": "06/08/2024 14:40",
  "ChangedBy": "Admin user",
  "Cultures": [
    { … },
    { … },
    { … }
  ]
}

ParametricGroupCultureModel

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

CultureCodestring or null[ 0 .. 16 ] characters

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

Namestring or null[ 0 .. 50 ] characters

The parametric group name in the specific language.

IsNameInheritedboolean

Indicates whether the parametric group name is inherited from the default language.

Descriptionstring or null[ 0 .. 500 ] characters

The parametric group description in the specific language.

IsDescriptionInheritedboolean

Indicates whether the parametric group description is inherited from the default language.

IsTranslatedboolean

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

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

ParametricListModel

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

Idinteger(int32)

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

Example: 20

ParametricIdinteger(int32)

The identifier of the parametric this list item belongs to.

Example: 8

Valuestring or null[ 0 .. 255 ] characters

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

Example: "Anthracite grey/Green"

DefaultValuestring or null[ 0 .. 255 ] characters

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

Example: "Anthracite grey/Green"

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 list item in a specific language. No size limit.

DefaultDescriptionstring or null

A longer description for the parametric list 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.

Codestring or null[ 0 .. 50 ] characters

Unique code identifier for the parametric list item.

Example: "antracitgra-green"

ImageKeystring or null(guid)

Unique blob identifier for an associated image.

ImageUrlstring or null[ 0 .. 255 ] characters

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

IsActiveboolean

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

Example: true

Changedstring or null

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

Example: "03/05/2024 13:01"

ChangedBystring or null

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

CulturesArray of objects(ParametricListCultureModel)

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

Example: [{"CultureCode":"en-GB","Value":"Anthracite grey/Green","IsValueInherited":false,"Description":"","IsDescriptionInherited":false,"IsTranslated":true},{"CultureCode":"sv-SE","Value":"Antracitgrå/Grön","IsValueInherited":false,"Description":null,"IsDescriptionInherited":true,"IsTranslated":true}]

{
  "Id": 20,
  "ParametricId": 8,
  "Value": "Anthracite grey/Green",
  "DefaultValue": "Anthracite grey/Green",
  "IsValueInherited": false,
  "Description": "",
  "DefaultDescription": "",
  "IsDescriptionInherited": false,
  "Code": "antracitgra-green",
  "ImageKey": null,
  "ImageUrl": "",
  "IsActive": true,
  "Changed": "03/05/2024 13:01",
  "ChangedBy": null,
  "Cultures": [
    { … },
    { … }
  ]
}

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

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