FileCultureModel

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

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

FileCultureModel

CultureCodestring or null[ 0 .. 16 ] characters

The culture code for this localization

IsTranslatedboolean

Indicates whether this culture data has been translated

Namestring or null[ 0 .. 50 ] characters

The localized name of the file type for this culture

IsNameInheritedboolean

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

Descriptionstring or null[ 0 .. 500 ] characters

The localized description of the file for this culture

IsDescriptionInheritedboolean

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

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

ManufacturerModel

Manufacturer model, represents a manufacturer with culture-specific properties. Manufacturers must be associated with products and is used together with the Manufacturer part number (PartNo) to identify products in mappings to supplier products.

Idinteger(int32)

Gets or sets the unique identifier for the manufacturer.

Keystring(guid)

Gets or sets the unique key for the manufacturer.

Namestring or null[ 0 .. 100 ] characters

Gets or sets the name of the manufacturer.

Codestring or null[ 0 .. 50 ] characters

Gets or sets the code of the manufacturer.

OrganizationNostring or null[ 0 .. 50 ] characters

Gets or sets the organization number of the manufacturer.

UniqueUrlNamestring or null

Gets or sets the unique URL name for the manufacturer. Can be used to lookup the manufacturer from landing pages using the API. Can be generated from the name by Norce.

IsUniqueUrlNameManuallyMaintainedboolean

Gets or sets a value indicating whether the unique URL name is manually maintained. If UnuqueUrlName is passed in, this is automatically set to true.

Prefixstring or null[ 0 .. 50 ] characters

Gets or sets the prefix for the manufacturer. Used when generating part numbers. Lookup PartNo generation in the documentation for more info.

Websitestring or null[ 0 .. 255 ] characters

Gets or sets the website URL for the manufacturer. For display purposes only.

LogoKeystring or null(guid)

Gets or sets the logo key for the manufacturer. For display purposes only.

LogoUrlstring or null

Gets or sets the logo URL for the manufacturer. For display purposes only.

SupportUrlstring or null[ 0 .. 255 ] characters

Gets or sets the support URL for the manufacturer, language specific. For display purposes only.

DefaultSupportUrlstring or null[ 0 .. 255 ] characters

Gets or sets the default support URL for the manufacturer, from default language.

IsSupportUrlInheritedboolean

Gets or sets a value indicating whether the support URL is inherited.

SupportEmailAddressstring or null[ 0 .. 255 ] characters

Gets or sets the support email address for the manufacturer language specific. For display purposes only.

DefaultSupportEmailAddressstring or null[ 0 .. 255 ] characters

Gets or sets the default support email address for the manufacturer, from default language.

IsSupportEmailAddressInheritedboolean

Gets or sets a value indicating whether the support email address is inherited.

SupportPhoneNumberstring or null[ 0 .. 500 ] characters

Gets or sets the support phone number for the manufacturer language specific. For display purposes only.

DefaultSupportPhoneNumberstring or null[ 0 .. 500 ] characters

Gets or sets the default support phone number for the manufacturer, from default language.

IsSupportPhoneNumberInheritedboolean

Gets or sets a value indicating whether the support phone number is inherited.

SupportAvailableHoursstring or null

Gets or sets the support available hours for the manufacturer language specific. For display purposes only.

DefaultSupportAvailableHoursstring or null

Gets or sets the default support available hours for the manufacturer, from default language.

IsSupportAvailableHoursInheritedboolean

Gets or sets a value indicating whether the support available hours is inherited.

SupportPolicystring or null

Gets or sets the support policy for the manufacturer language specific. For display purposes only.

DefaultSupportPolicystring or null

Gets or sets the default support policy for the manufacturer, from default language.

IsSupportPolicyInheritedboolean

Gets or sets a value indicating whether the support policy is inherited.

SupportDescriptionstring or null

Gets or sets the support description for the manufacturer language specific. For display purposes only.

DefaultSupportDescriptionstring or null

Gets or sets the default support description for the manufacturer, from default language.

IsSupportDescriptionInheritedboolean

Gets or sets a value indicating whether the support description is inherited.

IsActiveboolean

Gets or sets a value indicating whether the manufacturer is active.

Changedstring or null(date-time)

Gets or sets the date and time when the manufacturer was last changed.

ChangedBystring or null

Gets or sets the user who last changed the manufacturer.

CulturesArray of objects(ManufacturerCultureModel)

Gets or sets the list of culture-specific manufacturer information.

{
  "Id": 0,
  "Key": "string",
  "Name": "string",
  "Code": "string",
  "OrganizationNo": "string",
  "UniqueUrlName": "string",
  "IsUniqueUrlNameManuallyMaintained": true,
  "Prefix": "string",
  "Website": "string",
  "LogoKey": "string",
  "LogoUrl": "string",
  "SupportUrl": "string",
  "DefaultSupportUrl": "string",
  "IsSupportUrlInherited": true,
  "SupportEmailAddress": "string",
  "DefaultSupportEmailAddress": "string",
  "IsSupportEmailAddressInherited": true,
  "SupportPhoneNumber": "string",
  "DefaultSupportPhoneNumber": "string",
  "IsSupportPhoneNumberInherited": true,
  "SupportAvailableHours": "string",
  "DefaultSupportAvailableHours": "string",
  "IsSupportAvailableHoursInherited": true,
  "SupportPolicy": "string",
  "DefaultSupportPolicy": "string",
  "IsSupportPolicyInherited": true,
  "SupportDescription": "string",
  "DefaultSupportDescription": "string",
  "IsSupportDescriptionInherited": true,
  "IsActive": true,
  "Changed": "2019-08-24T14:15:22Z",
  "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