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

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

Get a price list

Request

Get a specific price list by its internal Id

Path
idinteger(int32)required

Price list id

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/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Bodyapplication/json
Idinteger(int32)

The unique identifier of the price list

PriceListIdinteger(int32)

The price list identifier

Namestring or null[ 0 .. 50 ] characters

The name of the price list

Descriptionstring or null

The description of the price list

Codestring or null[ 0 .. 50 ] characters

The agreement code for the price list

ImageKeystring or null(guid)

The unique key identifier for the price list image, not normally used.

ImageUrlstring or null[ 0 .. 255 ] characters

The URL path to the price list image, deprecated, not normally used.

TypeIdinteger(int32)

The type identifier of the price list

TypeNamestring or null

The name of the price list type

PriceRuleNamestring or null

The name of the default price rule associated with this price list

StartDatestring or null(date-time)

The start date when the price list becomes active

EndDatestring or null(date-time)

The end date when the price list becomes inactive

CurrencyIdinteger(int32)

The identifier for the currency the price list uses

CurrencyCodestring or null

The currency code for the currency the price list uses

CurrencyNamestring or null

The name of the currency used in the price list

SalesAreaIdinteger or null(int32)

The sales area identifier associated with this price list, if null, no specific sales area is assigned and is usually inherited from the application it is connected to or from the primary sales area of the client. This is primarily used for rounding rules, where rounding is calculated on the including VAT sale price.

SalesAreaNamestring or null

The name of the sales area associated with this price list

SalesAreaIdIsInheritedboolean

Indicates whether the sales area ID is inherited from parent

InheritedSalesAreaNamestring or null

The name of the inherited sales area, shows the current application sales area.

DefaultPriceRuleIdinteger or null(int32)

The default price rule identifier for this price list

DefaultPriceRuleValuenumber or null(decimal)

The value for the default price rule

DefaultSupplementChargePercentagenumber(decimal)

The default supplement charge percentage applied to products

DefaultSupplementChargenumber or null(decimal)

The default supplement charge amount applied to products

DefaultMinimumProductMarginPercentagenumber or null(decimal)

The default minimum product margin percentage

DefaultLimitToPriceRecommendedboolean or null

Indicates whether prices are limited to recommended prices

InheritStructureCalculationRuleinteger(int32)

The rule for inheriting structure calculation settings

ParentPriceListIdinteger or null(int32)

The identifier of the parent price list for inheritance. If null, some price rules are not working.

ParentPriceListNamestring or null

The name of the parent price list

PopulationRuleIdinteger(int32)

The population rule identifier used for product population

PopulationRuleNamestring or null

The name of the population rule

ChosenWarehouseIdinteger or null(int32)

The chosen warehouse identifier for this price list. The primary warehouse that is used for stock checking and availability.

ChosenLocationIdinteger or null(int32)

The chosen location identifier for this price list. The primary location that is used for stock checking and availability. This is usually used as the location receiving stock reservation by Norce shopping logic.

IsPrimaryboolean

Indicates whether this is the primary price list for the current application.

IsPublicboolean

Indicates whether the price list has prices that is publicly accessible from the application.

IsNotStartedboolean

Indicates whether the price list has not started yet

IsEndedboolean

Indicates whether the price list has ended.

IsVirtualboolean

Indicates whether this is a virtual price list. Virtual price lists are calculated in real-time and do not store prices. Requires a parent price list that provide the base information and assortment.

IsLimitedToStockboolean or null

Indicates whether the price list is limited to available stock. Currently not functional.

IsFavoriteboolean

Indicates whether this price list is marked as favorite in the current application in the admin interface.

IsActiveboolean

Indicates whether the price list is currently active, note this may still be a price list that has not started or has ended.

Changedstring or null

The date and time when the price list was last changed

ChangedBystring or null

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

Response
application/json
{ "Id": 0, "PriceListId": 0, "Name": "string", "Description": "string", "Code": "string", "ImageKey": "string", "ImageUrl": "string", "TypeId": 0, "TypeName": "string", "PriceRuleName": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "CurrencyId": 0, "CurrencyCode": "string", "CurrencyName": "string", "SalesAreaId": 0, "SalesAreaName": "string", "SalesAreaIdIsInherited": true, "InheritedSalesAreaName": "string", "DefaultPriceRuleId": 0, "DefaultPriceRuleValue": 0, "DefaultSupplementChargePercentage": 0, "DefaultSupplementCharge": 0, "DefaultMinimumProductMarginPercentage": 0, "DefaultLimitToPriceRecommended": true, "InheritStructureCalculationRule": 0, "ParentPriceListId": 0, "ParentPriceListName": "string", "PopulationRuleId": 0, "PopulationRuleName": "string", "ChosenWarehouseId": 0, "ChosenLocationId": 0, "IsPrimary": true, "IsPublic": true, "IsNotStarted": true, "IsEnded": true, "IsVirtual": true, "IsLimitedToStock": true, "IsFavorite": true, "IsActive": true, "Changed": "string", "ChangedBy": "string" }

Update a price list

Request

Update a specific price list by its internal Id

Path
idinteger(int32)required

Price list id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Price List to update

Idinteger(int32)

The unique identifier of the price list

PriceListIdinteger(int32)

The price list identifier

Namestring or null[ 0 .. 50 ] characters

The name of the price list

Descriptionstring or null

The description of the price list

Codestring or null[ 0 .. 50 ] characters

The agreement code for the price list

ImageKeystring or null(guid)

The unique key identifier for the price list image, not normally used.

ImageUrlstring or null[ 0 .. 255 ] characters

The URL path to the price list image, deprecated, not normally used.

TypeIdinteger(int32)

The type identifier of the price list

TypeNamestring or null

The name of the price list type

PriceRuleNamestring or null

The name of the default price rule associated with this price list

StartDatestring or null(date-time)

The start date when the price list becomes active

EndDatestring or null(date-time)

The end date when the price list becomes inactive

CurrencyIdinteger(int32)

The identifier for the currency the price list uses

CurrencyCodestring or null

The currency code for the currency the price list uses

CurrencyNamestring or null

The name of the currency used in the price list

SalesAreaIdinteger or null(int32)

The sales area identifier associated with this price list, if null, no specific sales area is assigned and is usually inherited from the application it is connected to or from the primary sales area of the client. This is primarily used for rounding rules, where rounding is calculated on the including VAT sale price.

SalesAreaNamestring or null

The name of the sales area associated with this price list

SalesAreaIdIsInheritedboolean

Indicates whether the sales area ID is inherited from parent

InheritedSalesAreaNamestring or null

The name of the inherited sales area, shows the current application sales area.

DefaultPriceRuleIdinteger or null(int32)

The default price rule identifier for this price list

DefaultPriceRuleValuenumber or null(decimal)

The value for the default price rule

DefaultSupplementChargePercentagenumber(decimal)

The default supplement charge percentage applied to products

DefaultSupplementChargenumber or null(decimal)

The default supplement charge amount applied to products

DefaultMinimumProductMarginPercentagenumber or null(decimal)

The default minimum product margin percentage

DefaultLimitToPriceRecommendedboolean or null

Indicates whether prices are limited to recommended prices

InheritStructureCalculationRuleinteger(int32)

The rule for inheriting structure calculation settings

ParentPriceListIdinteger or null(int32)

The identifier of the parent price list for inheritance. If null, some price rules are not working.

ParentPriceListNamestring or null

The name of the parent price list

PopulationRuleIdinteger(int32)

The population rule identifier used for product population

PopulationRuleNamestring or null

The name of the population rule

ChosenWarehouseIdinteger or null(int32)

The chosen warehouse identifier for this price list. The primary warehouse that is used for stock checking and availability.

ChosenLocationIdinteger or null(int32)

The chosen location identifier for this price list. The primary location that is used for stock checking and availability. This is usually used as the location receiving stock reservation by Norce shopping logic.

IsPrimaryboolean

Indicates whether this is the primary price list for the current application.

IsPublicboolean

Indicates whether the price list has prices that is publicly accessible from the application.

IsNotStartedboolean

Indicates whether the price list has not started yet

IsEndedboolean

Indicates whether the price list has ended.

IsVirtualboolean

Indicates whether this is a virtual price list. Virtual price lists are calculated in real-time and do not store prices. Requires a parent price list that provide the base information and assortment.

IsLimitedToStockboolean or null

Indicates whether the price list is limited to available stock. Currently not functional.

IsFavoriteboolean

Indicates whether this price list is marked as favorite in the current application in the admin interface.

IsActiveboolean

Indicates whether the price list is currently active, note this may still be a price list that has not started or has ended.

Changedstring or null

The date and time when the price list was last changed

ChangedBystring or null

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

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/pricelist/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "PriceListId": 0,
    "Name": "string",
    "Description": "string",
    "Code": "string",
    "ImageKey": "string",
    "ImageUrl": "string",
    "TypeId": 0,
    "TypeName": "string",
    "PriceRuleName": "string",
    "StartDate": "2019-08-24T14:15:22Z",
    "EndDate": "2019-08-24T14:15:22Z",
    "CurrencyId": 0,
    "CurrencyCode": "string",
    "CurrencyName": "string",
    "SalesAreaId": 0,
    "SalesAreaName": "string",
    "SalesAreaIdIsInherited": true,
    "InheritedSalesAreaName": "string",
    "DefaultPriceRuleId": 0,
    "DefaultPriceRuleValue": 0,
    "DefaultSupplementChargePercentage": 0,
    "DefaultSupplementCharge": 0,
    "DefaultMinimumProductMarginPercentage": 0,
    "DefaultLimitToPriceRecommended": true,
    "InheritStructureCalculationRule": 0,
    "ParentPriceListId": 0,
    "ParentPriceListName": "string",
    "PopulationRuleId": 0,
    "PopulationRuleName": "string",
    "ChosenWarehouseId": 0,
    "ChosenLocationId": 0,
    "IsPrimary": true,
    "IsPublic": true,
    "IsNotStarted": true,
    "IsEnded": true,
    "IsVirtual": true,
    "IsLimitedToStock": true,
    "IsFavorite": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string"
  }'

Responses

If the price list was successfully updated

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

List price lists

Request

Get a list of all price lists for the client

Query
filterstring

Filters price lists by status. Supported values:

  • "open": active and upcoming price lists that have not ended
  • "active": all active price lists within start/end dates
  • "inactive": inactive or ended price lists Default is "open".
Default "open"
searchstring or null

Search for price lists on name or code (case-insensitive)

pageinteger or null(int32)

Page number (1-based). When null, returns all price lists

pageSizeinteger or null(int32)

Number of items per page. Only used when page is provided

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 \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns a list of price lists, if any exist

Bodyapplication/jsonArray [
Idinteger(int32)

The unique identifier of the price list

PriceListIdinteger(int32)

The price list identifier

Namestring or null[ 0 .. 50 ] characters

The name of the price list

Descriptionstring or null

The description of the price list

Codestring or null[ 0 .. 50 ] characters

The agreement code for the price list

ImageKeystring or null(guid)

The unique key identifier for the price list image, not normally used.

ImageUrlstring or null[ 0 .. 255 ] characters

The URL path to the price list image, deprecated, not normally used.

TypeIdinteger(int32)

The type identifier of the price list

TypeNamestring or null

The name of the price list type

PriceRuleNamestring or null

The name of the default price rule associated with this price list

StartDatestring or null(date-time)

The start date when the price list becomes active

EndDatestring or null(date-time)

The end date when the price list becomes inactive

CurrencyIdinteger(int32)

The identifier for the currency the price list uses

CurrencyCodestring or null

The currency code for the currency the price list uses

CurrencyNamestring or null

The name of the currency used in the price list

SalesAreaIdinteger or null(int32)

The sales area identifier associated with this price list, if null, no specific sales area is assigned and is usually inherited from the application it is connected to or from the primary sales area of the client. This is primarily used for rounding rules, where rounding is calculated on the including VAT sale price.

SalesAreaNamestring or null

The name of the sales area associated with this price list

SalesAreaIdIsInheritedboolean

Indicates whether the sales area ID is inherited from parent

InheritedSalesAreaNamestring or null

The name of the inherited sales area, shows the current application sales area.

DefaultPriceRuleIdinteger or null(int32)

The default price rule identifier for this price list

DefaultPriceRuleValuenumber or null(decimal)

The value for the default price rule

DefaultSupplementChargePercentagenumber(decimal)

The default supplement charge percentage applied to products

DefaultSupplementChargenumber or null(decimal)

The default supplement charge amount applied to products

DefaultMinimumProductMarginPercentagenumber or null(decimal)

The default minimum product margin percentage

DefaultLimitToPriceRecommendedboolean or null

Indicates whether prices are limited to recommended prices

InheritStructureCalculationRuleinteger(int32)

The rule for inheriting structure calculation settings

ParentPriceListIdinteger or null(int32)

The identifier of the parent price list for inheritance. If null, some price rules are not working.

ParentPriceListNamestring or null

The name of the parent price list

PopulationRuleIdinteger(int32)

The population rule identifier used for product population

PopulationRuleNamestring or null

The name of the population rule

ChosenWarehouseIdinteger or null(int32)

The chosen warehouse identifier for this price list. The primary warehouse that is used for stock checking and availability.

ChosenLocationIdinteger or null(int32)

The chosen location identifier for this price list. The primary location that is used for stock checking and availability. This is usually used as the location receiving stock reservation by Norce shopping logic.

IsPrimaryboolean

Indicates whether this is the primary price list for the current application.

IsPublicboolean

Indicates whether the price list has prices that is publicly accessible from the application.

IsNotStartedboolean

Indicates whether the price list has not started yet

IsEndedboolean

Indicates whether the price list has ended.

IsVirtualboolean

Indicates whether this is a virtual price list. Virtual price lists are calculated in real-time and do not store prices. Requires a parent price list that provide the base information and assortment.

IsLimitedToStockboolean or null

Indicates whether the price list is limited to available stock. Currently not functional.

IsFavoriteboolean

Indicates whether this price list is marked as favorite in the current application in the admin interface.

IsActiveboolean

Indicates whether the price list is currently active, note this may still be a price list that has not started or has ended.

Changedstring or null

The date and time when the price list was last changed

ChangedBystring or null

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

]
Response
application/json
[ { "Id": 0, "PriceListId": 0, "Name": "string", "Description": "string", "Code": "string", "ImageKey": "string", "ImageUrl": "string", "TypeId": 0, "TypeName": "string", "PriceRuleName": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "CurrencyId": 0, "CurrencyCode": "string", "CurrencyName": "string", "SalesAreaId": 0, "SalesAreaName": "string", "SalesAreaIdIsInherited": true, "InheritedSalesAreaName": "string", "DefaultPriceRuleId": 0, "DefaultPriceRuleValue": 0, "DefaultSupplementChargePercentage": 0, "DefaultSupplementCharge": 0, "DefaultMinimumProductMarginPercentage": 0, "DefaultLimitToPriceRecommended": true, "InheritStructureCalculationRule": 0, "ParentPriceListId": 0, "ParentPriceListName": "string", "PopulationRuleId": 0, "PopulationRuleName": "string", "ChosenWarehouseId": 0, "ChosenLocationId": 0, "IsPrimary": true, "IsPublic": true, "IsNotStarted": true, "IsEnded": true, "IsVirtual": true, "IsLimitedToStock": true, "IsFavorite": true, "IsActive": true, "Changed": "string", "ChangedBy": "string" } ]

Add a price list

Request

Add a new price list to the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

Price List to add

Idinteger(int32)

The unique identifier of the price list

PriceListIdinteger(int32)

The price list identifier

Namestring or null[ 0 .. 50 ] characters

The name of the price list

Descriptionstring or null

The description of the price list

Codestring or null[ 0 .. 50 ] characters

The agreement code for the price list

ImageKeystring or null(guid)

The unique key identifier for the price list image, not normally used.

ImageUrlstring or null[ 0 .. 255 ] characters

The URL path to the price list image, deprecated, not normally used.

TypeIdinteger(int32)

The type identifier of the price list

TypeNamestring or null

The name of the price list type

PriceRuleNamestring or null

The name of the default price rule associated with this price list

StartDatestring or null(date-time)

The start date when the price list becomes active

EndDatestring or null(date-time)

The end date when the price list becomes inactive

CurrencyIdinteger(int32)

The identifier for the currency the price list uses

CurrencyCodestring or null

The currency code for the currency the price list uses

CurrencyNamestring or null

The name of the currency used in the price list

SalesAreaIdinteger or null(int32)

The sales area identifier associated with this price list, if null, no specific sales area is assigned and is usually inherited from the application it is connected to or from the primary sales area of the client. This is primarily used for rounding rules, where rounding is calculated on the including VAT sale price.

SalesAreaNamestring or null

The name of the sales area associated with this price list

SalesAreaIdIsInheritedboolean

Indicates whether the sales area ID is inherited from parent

InheritedSalesAreaNamestring or null

The name of the inherited sales area, shows the current application sales area.

DefaultPriceRuleIdinteger or null(int32)

The default price rule identifier for this price list

DefaultPriceRuleValuenumber or null(decimal)

The value for the default price rule

DefaultSupplementChargePercentagenumber(decimal)

The default supplement charge percentage applied to products

DefaultSupplementChargenumber or null(decimal)

The default supplement charge amount applied to products

DefaultMinimumProductMarginPercentagenumber or null(decimal)

The default minimum product margin percentage

DefaultLimitToPriceRecommendedboolean or null

Indicates whether prices are limited to recommended prices

InheritStructureCalculationRuleinteger(int32)

The rule for inheriting structure calculation settings

ParentPriceListIdinteger or null(int32)

The identifier of the parent price list for inheritance. If null, some price rules are not working.

ParentPriceListNamestring or null

The name of the parent price list

PopulationRuleIdinteger(int32)

The population rule identifier used for product population

PopulationRuleNamestring or null

The name of the population rule

ChosenWarehouseIdinteger or null(int32)

The chosen warehouse identifier for this price list. The primary warehouse that is used for stock checking and availability.

ChosenLocationIdinteger or null(int32)

The chosen location identifier for this price list. The primary location that is used for stock checking and availability. This is usually used as the location receiving stock reservation by Norce shopping logic.

IsPrimaryboolean

Indicates whether this is the primary price list for the current application.

IsPublicboolean

Indicates whether the price list has prices that is publicly accessible from the application.

IsNotStartedboolean

Indicates whether the price list has not started yet

IsEndedboolean

Indicates whether the price list has ended.

IsVirtualboolean

Indicates whether this is a virtual price list. Virtual price lists are calculated in real-time and do not store prices. Requires a parent price list that provide the base information and assortment.

IsLimitedToStockboolean or null

Indicates whether the price list is limited to available stock. Currently not functional.

IsFavoriteboolean

Indicates whether this price list is marked as favorite in the current application in the admin interface.

IsActiveboolean

Indicates whether the price list is currently active, note this may still be a price list that has not started or has ended.

Changedstring or null

The date and time when the price list was last changed

ChangedBystring or null

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

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/pricing/pricelist \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "PriceListId": 0,
    "Name": "string",
    "Description": "string",
    "Code": "string",
    "ImageKey": "string",
    "ImageUrl": "string",
    "TypeId": 0,
    "TypeName": "string",
    "PriceRuleName": "string",
    "StartDate": "2019-08-24T14:15:22Z",
    "EndDate": "2019-08-24T14:15:22Z",
    "CurrencyId": 0,
    "CurrencyCode": "string",
    "CurrencyName": "string",
    "SalesAreaId": 0,
    "SalesAreaName": "string",
    "SalesAreaIdIsInherited": true,
    "InheritedSalesAreaName": "string",
    "DefaultPriceRuleId": 0,
    "DefaultPriceRuleValue": 0,
    "DefaultSupplementChargePercentage": 0,
    "DefaultSupplementCharge": 0,
    "DefaultMinimumProductMarginPercentage": 0,
    "DefaultLimitToPriceRecommended": true,
    "InheritStructureCalculationRule": 0,
    "ParentPriceListId": 0,
    "ParentPriceListName": "string",
    "PopulationRuleId": 0,
    "PopulationRuleName": "string",
    "ChosenWarehouseId": 0,
    "ChosenLocationId": 0,
    "IsPrimary": true,
    "IsPublic": true,
    "IsNotStarted": true,
    "IsEnded": true,
    "IsVirtual": true,
    "IsLimitedToStock": true,
    "IsFavorite": true,
    "IsActive": true,
    "Changed": "string",
    "ChangedBy": "string"
  }'

Responses

If the price list was successfully added

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

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