MANAGEMENT API

PriceListSupplierPriceListModel

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

PriceListPricingModel

PriceListPricing model, represents price rules applied to a price list based on various criteria.

Idinteger(int32)

The unique identifier of the price list pricing rule

PriceListIdinteger(int32)

The identifier of the price list this pricing rule belongs to

CategoryIdinteger or null(int32)

The identifier of the category this pricing rule applies to

CategoryNamestring or null

The name of the category this pricing rule applies to

CategoryPathstring or null

The hierarchical path of the category this pricing rule applies to

CategoryParentCountinteger(int32)

The number of parent categories in the category hierarchy

CategoryCodestring or null

The code of the category this pricing rule applies to

ManufacturerIdinteger or null(int32)

The identifier of the manufacturer this pricing rule applies to

ManufacturerNamestring or null

The name of the manufacturer this pricing rule applies to

ManufacturerCodestring or null

The code of the manufacturer this pricing rule applies to

FlagsArray of objects(IdNameCodeModel)

The collection of flags associated with this pricing rule

FlagIdSeedstring or null[ 0 .. 1000 ] characters

The seed string containing flag identifiers for this pricing rule

FlagNamesArray of strings or null

The collection of flag names associated with this pricing rule

MinValuenumber or null(double)

The minimum value threshold for this pricing rule to apply

MaxValuenumber or null(double)

The maximum value threshold for this pricing rule to apply

PriceRuleIdinteger or null(int32)

The identifier of the built-in price rule used in this pricing configuration

PriceRuleNamestring or null

The name of the built-in price rule used in this pricing configuration

PriceRuleLabelstring or null

The label of the built-in price rule used in this pricing configuration

PriceRuleValuenumber or null(double)

The value associated with the price rule in this pricing configuration, depending on the built-in rule type this value can be rebate, margin, uplift, or fixed price. See documentation for more information.

PriceRuleUnitstring or null

The unit of the price rule value, usually percent or amount.

KickbackPercentagenumber or null(double)

The kickback percentage applied in this pricing rule, not normally used.

MinimumProductMarginPercentagenumber or null(double)

The minimum product margin percentage required for this pricing rule. Require purchase or unit costs on the products. Does not affect prixed price rules.

MinimumProductMarginPercentageIsInheritedboolean

Indicates whether the minimum product margin percentage is inherited from parent rules

PreferredPositioninteger or null(int32)

The preferred position order compared to competitors for this pricing rule when competive price rules are used.

LimitToPriceRecommendedboolean or null

Indicates whether sales price must not exceed the recommended price. Required by some manufacturers. Pricing rule will adjust price down if needed.

SupplementChargenumber or null(double)

The fixed supplement charge amount applied to the cost before price rule calculation by this pricing rule, ignored if SupplementChargePercentage is used. Valid for only cost based pricing rules.

SupplementChargePercentagenumber or null(double)

The supplement charge percentage applied to the cost before price rule calculation by this pricing rule. Valid for only cost based pricing rules.

IsActiveboolean

Indicates whether this pricing rule is currently active

Changedstring or null

The date and time when this pricing rule was last changed

ChangedBystring or null

The fullname or systemname of the user who last changed this pricing rule

{
  "Id": 0,
  "PriceListId": 0,
  "CategoryId": 0,
  "CategoryName": "string",
  "CategoryPath": "string",
  "CategoryParentCount": 0,
  "CategoryCode": "string",
  "ManufacturerId": 0,
  "ManufacturerName": "string",
  "ManufacturerCode": "string",
  "Flags": [
    { … }
  ],
  "FlagIdSeed": "string",
  "FlagNames": [
    "string"
  ],
  "MinValue": 0.1,
  "MaxValue": 0.1,
  "PriceRuleId": 0,
  "PriceRuleName": "string",
  "PriceRuleLabel": "string",
  "PriceRuleValue": 0.1,
  "PriceRuleUnit": "string",
  "KickbackPercentage": 0.1,
  "MinimumProductMarginPercentage": 0.1,
  "MinimumProductMarginPercentageIsInherited": true,
  "PreferredPosition": 0,
  "LimitToPriceRecommended": true,
  "SupplementCharge": 0.1,
  "SupplementChargePercentage": 0.1,
  "IsActive": true,
  "Changed": "string",
  "ChangedBy": "string"
}

PriceListSupplierPriceListModel

PriceListSupplierPriceList model, represents a supplier price list linked to a price list. Providing procurement data and other supplier product data for the product and price list. Allows for Chosen supplier functionality.

Idinteger(int32)

The unique identifier of the supplier price list

PriceListIdinteger(int32)

The unique identifier of the (client) price list

Namestring or null[ 0 .. 50 ] characters

The name of the supplier price list

SupplierNamestring or null

The name of the supplier

SupplierIdinteger(int32)

The unique identifier of the supplier

SupplierCodestring or null

The supplier code

SupplierCountrystring or null

The country of the supplier

SupplierIsChosenSupplierEnabledboolean

Indicates whether the supplier has chosen supplier functionality enabled

SupplierPriceListCurrencyCodestring or null

The currency code of the supplier price list

Codestring or null

The code of the supplier price list

Changedstring or null

The date and time when the record was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the record

{
  "Id": 0,
  "PriceListId": 0,
  "Name": "string",
  "SupplierName": "string",
  "SupplierId": 0,
  "SupplierCode": "string",
  "SupplierCountry": "string",
  "SupplierIsChosenSupplierEnabled": true,
  "SupplierPriceListCurrencyCode": "string",
  "Code": "string",
  "Changed": "string",
  "ChangedBy": "string"
}

PriceListTypeModel

PriceListType model, represents a type classification for price lists. Types help categorize price lists for different purposes.

Idinteger(int32)

The system wide unique identifier of the price list type

Namestring or null[ 0 .. 50 ] characters

The name of the price list type

Descriptionstring or null[ 0 .. 500 ] characters

The description of the price list type

IsActiveboolean

Indicates whether this price list type is active

Changedstring or null

The date and time the price list type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the price list type

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