MANAGEMENT API

FlagGroupCultureModel

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

FileModel

File model, represents a client configured file or image type for products with culture-specific properties.

Idinteger(int32)

The unique identifier of the file type

Namestring or null[ 0 .. 50 ] characters

The localized name of the file type for a specific culture

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the file type for the default language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null[ 0 .. 500 ] characters

The localized description of the file type for a specific culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The description of the file type for the default language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

Codestring or null

The code identifier of the file

TypeIdinteger(int32)required

The type identifier of the file, e.g., jpg, gif, pdf, mp4, etc.

TypeExtensionstring or null

The file extension, from the built-in file type for this file type, e.g., "jpg", "gif", "pdf", "mp4" etc.

TypeMimeTypestring or null

The MIME type, from the built-in file type for this file type, e.g., "image/jpeg", "application/pdf", etc.

SortOrderinteger or null(int32)

The sort order of the file type, used for displaying file types in choices and lists in the admin interface. And is also provided in API results.

IsActivebooleanrequired

Indicates whether the file type is active

IsImageboolean

Indicates whether the file type is an image

Changedstring or null

The date and time the file type was last changed

ChangedBystring or null

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

CulturesArray of objects(FileCultureModel)

The collection of culture-specific data for the file type

{
  "Id": 0,
  "Name": "string",
  "DefaultName": "string",
  "IsNameInherited": true,
  "Description": "string",
  "DefaultDescription": "string",
  "IsDescriptionInherited": true,
  "Code": "string",
  "TypeId": 0,
  "TypeExtension": "string",
  "TypeMimeType": "string",
  "SortOrder": 0,
  "IsActive": true,
  "IsImage": true,
  "Changed": "string",
  "ChangedBy": "string",
  "Cultures": [
    { … }
  ]
}

FlagGroupCultureModel

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 flag group name in the specific language.

IsNameInheritedboolean

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

Descriptionstring or null[ 0 .. 500 ] characters

The flag group description in the specific language.

IsDescriptionInheritedboolean

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

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

FlagGroupModel

FlagGroup model, represents a group of flags, giving more context to them. The group define if flags can have many selected from the group at the same time as well. If false, any other flag set will be unset from the group, when a new flag is selected.

Idinteger(int32)

Internal identifier for the flag group. Client-specific.

Codestring or null[ 0 .. 50 ] characters

Unique code identifier for the flag group.

Namestring or null[ 0 .. 50 ] characters

The flag group name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

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

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The flag group description in the default language.

IsDescriptionInheritedboolean

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

IsMultipleChoiceboolean

Indicates whether multiple flags can be selected from this group at the same time. If false, selecting a new flag will unset other flags from the group.

IsActiveboolean

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

IsFavoriteboolean

Indicates whether this flag group is marked as a favorite and displayed prominently on the product page in the admin interface. Used purely for UI purposes.

Changedstring or null(date-time)

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

ChangedBystring or null

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

CulturesArray of objects(FlagGroupCultureModel)

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

{
  "Id": 0,
  "Code": "string",
  "Name": "string",
  "DefaultName": "string",
  "IsNameInherited": true,
  "Description": "string",
  "DefaultDescription": "string",
  "IsDescriptionInherited": true,
  "IsMultipleChoice": true,
  "IsActive": true,
  "IsFavorite": true,
  "Changed": "2019-08-24T14:15:22Z",
  "ChangedBy": "string",
  "Cultures": [
    { … }
  ]
}