MANAGEMENT API
/
PriceList Pricing
/
Add or Update price list pricing rules

Management API (v1)

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

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Schemas

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

List price list pricing rules

Request

Get a list of all price list pricing rules for a specific price list

Path
priceListIdinteger(int32)required
Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/pricelist/{priceListId}/pricing' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of price list pricing rules, if any exists

Bodyapplication/jsonArray [
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 (IdNameCodeModel (object or null))

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 or null

The collection of flag names associated with this pricing rule

MinValuenumber or null(decimal)

The minimum value threshold for this pricing rule to apply

MaxValuenumber or null(decimal)

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(decimal)

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(decimal)

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

MinimumProductMarginPercentagenumber or null(decimal)

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(decimal)

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(decimal)

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

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

Add or Update price list pricing rules

Request

Update the complete list of price list pricing rules for a specific price list

Path
priceListIdinteger(int32)required

Price list id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

A complete list of price list pricing rules to set, existing rules will be replaced. New rules are allowed.

Array [
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 (IdNameCodeModel (object or null))

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 or null

The collection of flag names associated with this pricing rule

MinValuenumber or null(decimal)

The minimum value threshold for this pricing rule to apply

MaxValuenumber or null(decimal)

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(decimal)

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(decimal)

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

MinimumProductMarginPercentagenumber or null(decimal)

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(decimal)

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(decimal)

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

]
curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/pricelist/{priceListId}/pricing' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '[
    {
      "Id": 0,
      "PriceListId": 0,
      "CategoryId": 0,
      "CategoryName": "string",
      "CategoryPath": "string",
      "CategoryParentCount": 0,
      "CategoryCode": "string",
      "ManufacturerId": 0,
      "ManufacturerName": "string",
      "ManufacturerCode": "string",
      "Flags": [
        {
          "Id": 0,
          "Name": "string",
          "Code": "string"
        }
      ],
      "FlagIdSeed": "string",
      "FlagNames": [
        "string"
      ],
      "MinValue": 0,
      "MaxValue": 0,
      "PriceRuleId": 0,
      "PriceRuleName": "string",
      "PriceRuleLabel": "string",
      "PriceRuleValue": 0,
      "PriceRuleUnit": "string",
      "KickbackPercentage": 0,
      "MinimumProductMarginPercentage": 0,
      "MinimumProductMarginPercentageIsInherited": true,
      "PreferredPosition": 0,
      "LimitToPriceRecommended": true,
      "SupplementCharge": 0,
      "SupplementChargePercentage": 0,
      "IsActive": true,
      "Changed": "string",
      "ChangedBy": "string"
    }
  ]'

Responses

If the price list pricing rules were successfully updated

Bodyapplication/json
integer(int32)
Response
application/json
0

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