Management API (v1)

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

Download OpenAPI description
Languages
Servers

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

Schemas

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

ManufacturerCultureModel

CultureCodestring or null[ 0 .. 16 ] characters

Gets or sets the culture code for this manufacturer culture.

SupportUrlstring or null[ 0 .. 255 ] characters

Gets or sets the support URL for this culture.

IsSupportUrlInheritedboolean

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

SupportEmailAddressstring or null[ 0 .. 255 ] characters

Gets or sets the support email address for this culture.

IsSupportEmailAddressInheritedboolean

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

SupportPhoneNumberstring or null[ 0 .. 500 ] characters

Gets or sets the support phone number for this culture.

IsSupportPhoneNumberInheritedboolean

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

SupportAvailableHoursstring or null

Gets or sets the support available hours for this culture.

IsSupportAvailableHoursInheritedboolean

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

SupportPolicystring or null

Gets or sets the support policy for this culture.

IsSupportPolicyInheritedboolean

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

SupportDescriptionstring or null

Gets or sets the support description for this culture.

IsSupportDescriptionInheritedboolean

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

IsTranslatedboolean

Gets or sets a value indicating whether this culture has been translated.

{ "CultureCode": "string", "SupportUrl": "string", "IsSupportUrlInherited": true, "SupportEmailAddress": "string", "IsSupportEmailAddressInherited": true, "SupportPhoneNumber": "string", "IsSupportPhoneNumberInherited": true, "SupportAvailableHours": "string", "IsSupportAvailableHoursInherited": true, "SupportPolicy": "string", "IsSupportPolicyInherited": true, "SupportDescription": "string", "IsSupportDescriptionInherited": true, "IsTranslated": true }

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

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

Category

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