FamilyCultureModel

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

FamilyModel

Family model, represents a family of products in the system. A family is a grouping of products that does not have to share common attributes. Families can be used to group products for various purposes, such as categorization, or filtering. Used commonly for series or common branding of products for display purposes. Not commonly used anymore. Parametric lists may fill the same functionality with more flexibility.

Idinteger(int32)

The unique identifier of the family

Codestring or null[ 0 .. 50 ] characters

The code identifier of the family

Namestring or null

The localized name of the family

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the family for the default language.

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null

The localized description of the family

DefaultDescriptionstring or null

The description of the family for the default language.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

IsActiveboolean

Indicates whether the family is active

ImageKeystring or null(guid)

Unique blob identifier for an associated image.

Changedstring or null

The date and time the family was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the family

CulturesArray of objects(FamilyCultureModel)

The collection of culture-specific data for the family

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

FamilyCultureModel

CultureCodestring or null[ 0 .. 16 ] characters

The culture code for this localization

Namestring or null[ 0 .. 50 ] characters

The localized name of the family for this culture

IsNameInheritedboolean

Indicates whether the name is inherited from the default for this culture

Descriptionstring or null

The localized description of the family for this culture

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default for this culture

IsTranslatedboolean

Indicates whether this culture data has been translated

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

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": [
    { … }
  ]
}

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