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

ClientSalesAreaModel

ClientSalesArea model, represents a sales area associated with the client, indicating whether the client has at least one application with this sales area enabled. Each sales area has a set of VAT codes associated with it, with one VAT code marked as primary for the sales area. This primary VAT code will be used as default VAT code for products unlesss overridden at category or product level.

Idinteger(int32)required

The sales area identifier.

Namestring or null[ 0 .. 255 ] characters

The name of the sales area.

Codestring or null[ 0 .. 50 ] characters

The code of the sales area.

IsPrimarybooleanrequired

Indicates whether this is the primary sales area for the client.

VatCodesArray of objects or null(ClientSalesAreaVatCodeModel)

The collection of VAT codes associated with this sales area for the client.

PrimaryVatCodeIdinteger(int32)required

The identifier of the primary VAT code for this sales area.

Changedstring or null

The date and time when the ClientSalesArea entity was last changed.

ChangedBystring or null

The name of the user who last changed the ClientSalesArea entity.

{ "Id": 0, "Name": "string", "Code": "string", "IsPrimary": true, "VatCodes": [ {} ], "PrimaryVatCodeId": 0, "Changed": "string", "ChangedBy": "string" }

ClientSalesAreaVatCodeModel

VAT code model associated with a client sales area.

Idinteger(int32)required

The VAT code identifier.

Namestring or null[ 0 .. 255 ] characters

The name of the VAT code.

Valuenumber(decimal)required

The VAT rate value as a decimal.

{ "Id": 0, "Name": "string", "Value": 0 }

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

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