Management API (v1)

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

Download OpenAPI description
Languages
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

Category

Manage categories

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

PromotionRequirementProductListModel

PromotionRequirementProductList model, represents a single product rule within a promotion requirement setting. Defines specific product filters such as manufacturer, category, flag, price list, product type, product, or variant.

Idinteger(int32)

The unique identifier for the product rule

ManufacturerIdinteger or null(int32)

The manufacturer filter for this product rule, null if not filtering by manufacturer

ManufacturerCodestring or null

The manufacturer code for this product rule, null if not filtering by manufacturer

ManufacturerNamestring or null

The manufacturer name for this product rule, null if not filtering by manufacturer

CategoryIdinteger or null(int32)

The category filter for this product rule, null if not filtering by category

CategoryCodestring or null

The category code for this product rule, null if not filtering by category

CategoryNamestring or null

The category name for this product rule, null if not filtering by category

FlagIdinteger or null(int32)

The flag filter for this product rule, null if not filtering by flag

FlagCodestring or null

The flag code for this product rule, null if not filtering by flag

FlagNamestring or null

The flag name for this product rule, null if not filtering by flag

IsFlagInclusiveboolean

Indicates whether the flag rule is "set" or "not set"

PriceListIdinteger or null(int32)

The price list filter for this product rule, null if not filtering by price list

PriceListCodestring or null

The price list code for this product rule, null if not filtering by price list

PriceListNamestring or null

The price list name for this product rule, null if not filtering by price list

ProductTypeIdinteger or null(int32)

The product type filter for this product rule, null if not filtering by product type

ProductTypeNamestring or null

The product type code for this product rule, null if not filtering by product type

ProductIdinteger or null(int32)

The product id filter for this product rule, null if not filtering by specific product

ProductHasVariantsboolean

True if the product has variants.

ProductNamestring or null

The product name for this product rule, null if not filtering by specific product

VariantProductIdinteger or null(int32)

The variant product id filter for this product rule, null if not filtering by specific variant product

VariantProductNamestring or null

The variant product name for this product rule, null if not filtering by specific variant product

PartNostring or null

The part number for the product or variant product

Qtyinteger(int32)

The quantity required for this product rule, null if applied on the requirement level

Changedstring or null

The date and time when this product rule was last changed.

ChangedBystring or null

The identifier of the user who last changed this product rule.

{ "Id": 0, "ManufacturerId": 0, "ManufacturerCode": "string", "ManufacturerName": "string", "CategoryId": 0, "CategoryCode": "string", "CategoryName": "string", "FlagId": 0, "FlagCode": "string", "FlagName": "string", "IsFlagInclusive": true, "PriceListId": 0, "PriceListCode": "string", "PriceListName": "string", "ProductTypeId": 0, "ProductTypeName": "string", "ProductId": 0, "ProductHasVariants": true, "ProductName": "string", "VariantProductId": 0, "VariantProductName": "string", "PartNo": "string", "Qty": 0, "Changed": "string", "ChangedBy": "string" }

PromotionRequirementSettingModel

PromotionRequirementSetting model, represents the settings for a specific promotion requirement. Defines the type of requirement, its parameters, and associated product filters, if any.

Idinteger(int32)

The unique identifier for the promotion requirement setting

RequirementTypestring

Requirement type can have one of the following values: BasketTotal, ProductFilter, ProductManufacturer, ProductCategory, ProductFlag, ProductPriceList, ProductType, DiscountCode, UniqueDiscountCode, ExternalDiscountCode, CustomerFlag, CompanyFlag

DiscountCodestring or null

The discount code associated with this requirement, applicable when the requirement type is DiscountCode. Can be null for other requirement types. Apply the code to basket to autimatically apply the promotion. Note that promotions may have more requirements than just the discount code.

ExternalDiscountCodestring or null

The external discount code associated with this requirement, applicable when the requirement type is ExternalDiscountCode. Can be null for other requirement types.

ValueTypestring or null

Read only value that is set depending on if OrderSum is set or not. Will be OrderSum if any OrderSum value is set and Quantity when not.

OrderSumnumber or null(double)

The order sum value for this requirement, applicable when the requirement type is BasketTotal. Can be null for other requirement types.

OrderSumMaxnumber or null(double)

The maximum order sum value for this requirement, applicable when the requirement type is BasketTotal and OrderSumType is Between. Can be null for other requirement types.

IsIncVatboolean or null

Specify how to validate the order sum. True for validating including VAT, false for excluding VAT.

ProductsIncludedstring or null

Determines how rows in ProductList is handled, default value is "And". All rows need to be valid when set to "And". At least one row need to be valid when set to "Or". No row can be valid when set to "Not".

CustomerFlagIdinteger or null(int32)

The customer flag identifier associated with this requirement, applicable when the requirement type is CustomerFlag. Can be null for other requirement types.

CustomerFlagNamestring or null

The customer flag name associated with this requirement, applicable when the requirement type is CustomerFlag. Can be null for other requirement types.

IsCustomerFlagIncludedboolean or null

Indicates whether the customer flag rule is "set" or "not set" for this requirement.

SortOrderinteger(int32)

Sort order for displaying the requirement in lists

ProductListArray of objects(PromotionRequirementProductListModel)

The list of products rules associated with this requirement, applicable when the requirement type is ProductFilter or any of the product specific types. Can be empty for other requirement types.

Changedstring or null

The date and time when this promotion requirement setting was last changed.

ChangedBystring or null

The identifier of the user who last changed this promotion requirement setting.

MatchByEachPartNoboolean

Indicates whether the requirement should match by each part number individually when validating product filter list.

GenericQtynumber or null(double)

The quantity requirement for the product filter, applicable when the requirement type is ProductFilter and the criteria is total quantity. Can be null for other requirement types.

GenericQtyMaxnumber or null(double)

The maximum quantity requirment for the product filter, applicable when the requirement type is ProductFilter and the criteria is total quantity with "between" as the criteria. Can be null for other requirement types.

{ "Id": 0, "RequirementType": "string", "DiscountCode": "string", "ExternalDiscountCode": "string", "ValueType": "string", "OrderSum": 0.1, "OrderSumMax": 0.1, "IsIncVat": true, "ProductsIncluded": "string", "CustomerFlagId": 0, "CustomerFlagName": "string", "IsCustomerFlagIncluded": true, "SortOrder": 0, "ProductList": [ {} ], "Changed": "string", "ChangedBy": "string", "MatchByEachPartNo": true, "GenericQty": 0.1, "GenericQtyMax": 0.1 }

PromotionStatisticsModel

Represents statistics for a promotion, including order totals, discount amounts, discount percentage, and margin percentage. These fields are separated from the main promotion model to allow independent fetching, as they can be expensive to compute.

TotalOrdernumber or null(double)

The total order amount for this promotion

TotalDiscountnumber or null(double)

The total discount amount given by this promotion

DiscountPercentagenumber or null(double)

The discount percentage applied by this promotion

MarginPercentagenumber or null(double)

The margin percentage for this promotion

{ "TotalOrder": 0.1, "TotalDiscount": 0.1, "DiscountPercentage": 0.1, "MarginPercentage": 0.1 }