MANAGEMENT API

ApplicationSalesAreaModel

Management API (v1)

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

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Playground

https://{slug}.api-se.playground.norce.tech/commerce/

Stage

https://{slug}.api-se.stage.norce.tech/commerce/

Production

https://{slug}.api-se.norce.tech/commerce/

Settings ApplicationCountry

Manage application countries

Operations

Settings ApplicationCulture

Manage application cultures

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

CategoryParametric

Manage parametric categories

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

PriceList ClientPriceListType

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 PriceListType

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

Schemas

ApplicationModel

Application model, represents a storefront for end customers to visit and purchase from, configured with currencies, countries, cultures, sales areas, payment methods, shipping methods, products, and much more.

Idinteger(int32)

The environment wide unique internal Norce Id of the application

Keystring(uuid)

The unique key of the application

Namestring or null<= 50 characters

The friendly name of the application

Descriptionstring or null<= 500 characters

A longer description of the application

HostClientIdinteger(int32)

The Host Client Id that owns this application

Urlstring or null<= 255 characters

The URL of the application, e.g. "https://demo.shop.com"

ProductUrlstring or null<= 255 characters

The base URL of the product catalog for the application, used together with a product unique identifier to get the product page from the shop. The allowed "wildcards" are {uniqueurl}, {productid} and {partno}, e.g. "https://demo.shop.com/products/{productId}", "https://demo.shop.com/products/{partNo}" or "https://demo.shop.com/products/{uniqueUrl}"

IsActiveboolean

If false, the application is deactivated and cannot be used by customers

Changedstring or null

The date and time when the Application entity was last changed

ChangedBystring or null

The name of the user who last changed the Application entity, null if never changed

{
  "Id": 0,
  "Key": "5eb041b0-19c9-4022-bd51-0e723885f5dd",
  "Name": "string",
  "Description": "string",
  "HostClientId": 0,
  "Url": "string",
  "ProductUrl": "string",
  "IsActive": true,
  "Changed": "string",
  "ChangedBy": "string"
}

ApplicationSalesAreaModel

ApplicationSalesArea model, represents a sales area added to the application, allows for end customers to buy using the sales area vat settings, as well as adding the sales area to the client, so that it may be used in other applications with the same settings. Each sales area must have at least one VatRate defined.

Idinteger(int32)

The system wide unique internal Norce Id of the sales area

Codestring or null<= 50 characters

Sales area code - a unique external identifier used by client systems, e.g. "SE", "US", "44", "FI", can be left as null.

Namestring or null<= 50 characters

Sales area name, cannot be updated, for display purposes only

IsPrimaryboolean

Primary application sales area. Must be set for only one of the active sales areas. Can be updated on an existing ApplicationSalesArea.

IsActiveboolean

If false, the sales area is soft deleted from the application

Changedstring or null

The date and time when the ApplicationSalesArea was last changed

ChangedBystring or null

The name of the user who last changed the ApplicationSalesArea, null if never changed

{
  "Id": 0,
  "Code": "string",
  "Name": "string",
  "IsPrimary": true,
  "IsActive": true,
  "Changed": "string",
  "ChangedBy": "string"
}

CategoryCultureModel

CultureCodestring or null[ 0 .. 16 ] characters

The culture code, e.g. "sv-SE" or "en-US".

Namestring or null[ 0 .. 50 ] characters

The category name in the specific language.

IsNameInheritedboolean

Indicates whether the category name is inherited from the default language.

Descriptionstring or null

The category description in the specific language.

IsDescriptionInheritedboolean

Indicates whether the category description is inherited from the default language.

Synonymsstring or null[ 0 .. 500 ] characters

Comma-separated list of phrases or words that can be indexed in the search functionality for the specific language.

IsSynonymsInheritedboolean

Indicates whether the synonyms are inherited from the default language.

FullNamestring or null[ 0 .. 500 ] characters

Concatenated category name based on hierarchy for the specific language. Format: root category - branch category - leaf category (for three levels).

IsFullNameInheritedboolean

Indicates whether the full name is inherited from the default language.

IsTranslatedboolean

Indicates whether any of the fields have been translated for this culture.

{
  "CultureCode": "string",
  "Name": "string",
  "IsNameInherited": true,
  "Description": "string",
  "IsDescriptionInherited": true,
  "Synonyms": "string",
  "IsSynonymsInherited": true,
  "FullName": "string",
  "IsFullNameInherited": true,
  "IsTranslated": true
}