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

CustomerFlagGroupModel

CustomerFlagGroup 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.

ClientIdinteger(int32)

The client identifier this customer flag group belongs to.

Namestring or null[ 0 .. 50 ] characters

The customer flag group name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

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

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The customer 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 customer flag group is soft deleted, removes it from the admin interface and non-functional but easily reactivatable.

Changedstring or null

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

ChangedBystring or null

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

CulturesArray of objects(CustomerFlagGroupCultureModel)

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

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

CustomerFlagGroupCultureModel

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

IsNameInheritedboolean

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

Descriptionstring or null[ 0 .. 500 ] characters

The customer flag group description in the specific language.

IsDescriptionInheritedboolean

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

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

CustomerFlagModel

CustomerFlag model, represents a flag that can be assigned to customers or companies to indicate specific attributes or statuses. Flags can be grouped and can have culture-specific names and descriptions. Customer and company flags can be used in business logic, like in promotion rules and effects.

Idinteger(int32)

Internal identifier for the customer flag. Client-specific.

Codestring or null[ 0 .. 50 ] characters

External reference code for the customer flag, used for integration purposes.

GroupIdinteger(int32)

The identifier of the group this customer flag belongs to.

GroupNamestring or null

The name of the group this customer flag belongs to.

Namestring or null[ 0 .. 50 ] characters

The customer flag name in a specific language.

DefaultNamestring or null[ 0 .. 50 ] characters

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

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The customer flag description in the default language.

IsDescriptionInheritedboolean

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

AvailableOnCustomerboolean

Indicates whether this flag can be assigned to customers.

AvailableOnCompanyboolean

Indicates whether this flag can be assigned to companies.

IsActiveboolean

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

Changedstring or null

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

ChangedBystring or null

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

IsDefaultboolean

Indicates whether this is a system default flag that cannot be deleted.

SortOrderinteger or null(int32)

The sort order for displaying this flag in lists and interfaces.

CulturesArray of objects(CustomerFlagCultureModel)

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

{ "Id": 0, "Code": "string", "GroupId": 0, "GroupName": "string", "Name": "string", "DefaultName": "string", "IsNameInherited": true, "Description": "string", "DefaultDescription": "string", "IsDescriptionInherited": true, "AvailableOnCustomer": true, "AvailableOnCompany": true, "IsActive": true, "Changed": "string", "ChangedBy": "string", "IsDefault": true, "SortOrder": 0, "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