MANAGEMENT API

ClientSalesAreaModel

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

ClientPriceListTypeModel

ClientPriceListType model, represents the associated price list types that are enabled for the client.

Idinteger(int32)required

The price list type identifier.

Codestring or null

The price list type code. Client specific.

Namestring or null[ 0 .. 50 ] characters

The localized and client specific name of the price list type.

DefaultNamestring or null[ 0 .. 50 ] characters

The default name of the price list type.

IsNameInheritedboolean

Indicates whether the name is inherited from the default name.

Descriptionstring or null[ 0 .. 500 ] characters

The localized and client specific description of the price list type.

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The default description of the price list type.

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default description.

SortOrderinteger or null(int32)

The sort order of the price list type. Client specific.

Priorityinteger or null(int32)

The priority of the price list type. Client specific. Used to determine the precedence of price list types when multiple types apply.

IsActiveboolean

Indicates whether the price list type is active on the client.

Changedstring or null

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

ChangedBystring or null

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

CulturesArray of objects(ClientPriceListTypeCultureModel)

The collection of culture-specific translations for this price list type.

{
  "Id": 0,
  "Code": "string",
  "Name": "string",
  "DefaultName": "string",
  "IsNameInherited": true,
  "Description": "string",
  "DefaultDescription": "string",
  "IsDescriptionInherited": true,
  "SortOrder": 0,
  "Priority": 0,
  "IsActive": true,
  "Changed": "string",
  "ChangedBy": "string",
  "Cultures": [
    { … }
  ]
}

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(double)required

The VAT rate value as a decimal.

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