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

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" }

PromotionEffectSettingModel

PromotionEffectSetting model, represents the settings for a specific promotion effect. Defines the type of effect, its parameters, and associated product lists, if any.

Idinteger(int32)
EffectTypestring

Effect type can have one of the following values: DiscountBasket, ProductFilter, ProductManufacturer, ProductCategory, ProductFlag, ProductPriceList, ProductType, DiscountFreight, AddProduct, SelectProduct

IsDiscountboolean or null

Indicates whether the effect is calculated as a percentage discount

IsFixedPriceboolean or null

Indicates whether the effect is a fixed price adjustment

Valuenumber or null(decimal)

The value associated with the effect, such as discount amount or fixed price

IsIncVatboolean

Indicates whether the value is inclusive of VAT, relevant for fixed price effects

IgnoreNonDiscountableboolean

Indicates whether non-discountable items should be ignored in the effect calculation (when products or variants has IsDiscountable = false on the price record)

DiscountMostExpensiveItemsboolean or null

Indicates whether the discount should apply to the most expensive items first, relevant for product filter effects that discount a subset of valid products

SortOrderinteger(int32)

The sort order for displaying the effect in lists

UseRequirementProductsboolean

Indicates whether to use requirement products as the product list for this effect, this is applicable when the effect discounts specific products and the requirement also defines products

GenericQtynumber or null(decimal)

The quantity effect for the product filter, applicable when effects discounts specific products and the criteria is a specific quantity. Can be null for other effect types and when "all" products are discounted.

ProductListArray of objects(PromotionEffectProductListModel)

The list of product rules associated with this effect, applicable when the effect type involves product filtering

Changedstring or null

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

ChangedBystring or null

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

{ "Id": 0, "EffectType": "string", "IsDiscount": true, "IsFixedPrice": true, "Value": 0, "IsIncVat": true, "IgnoreNonDiscountable": true, "DiscountMostExpensiveItems": true, "SortOrder": 0, "UseRequirementProducts": true, "GenericQty": 0, "ProductList": [ {} ], "Changed": "string", "ChangedBy": "string" }

PromotionEffectProductListModel

PromotionEffectProductList model, represents a single product rule within a promotion effect 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 effect rule

ManufacturerIdinteger or null(int32)

The manufacturer identifier for filtering products by manufacturer, null if not filtering by manufacturer

ManufacturerCodestring or null

The manufacturer code for filtering products by manufacturer, null if not filtering by manufacturer

ManufacturerNamestring or null

The manufacturer name for filtering products by manufacturer, null if not filtering by manufacturer

CategoryIdinteger or null(int32)

The category identifier for filtering products by category, null if not filtering by category

CategoryCodestring or null

The category code for filtering products by category, null if not filtering by category

CategoryNamestring or null

The category name for filtering products by category, null if not filtering by category

FlagIdinteger or null(int32)

The flag identifier for filtering products by flag, null if not filtering by flag

FlagCodestring or null

The flag code for filtering products by flag, null if not filtering by flag

FlagNamestring or null

The flag name for filtering products by flag, null if not filtering by flag

IsFlagInclusiveboolean

Indicates whether the flag rule is "set" or "not set" for filtering products by flag

PriceListIdinteger or null(int32)

The price list identifier for filtering products by price list, null if not filtering by price list

PriceListCodestring or null

The price list code for filtering products by price list, null if not filtering by price list

PriceListNamestring or null

The price list name for filtering products by price list, null if not filtering by price list

ProductTypeIdinteger or null(int32)

The product type identifier for filtering products by product type, null if not filtering by product type

ProductTypeNamestring or null

The product type name for filtering products by product type, 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 filtering by specific product, 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 filtering by specific variant product, null if not filtering by specific variant product

PartNostring or null

The part number for the product or variant product

Qtyinteger or null(int32)

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

IsDiscountboolean or null

Indicates whether the effect is calculated as a percentage discount

IsFixedPriceboolean or null

Indicates whether the effect is a fixed price adjustment

Valuenumber or null(decimal)

The value associated with the effect, such as discount amount or fixed price

IsIncVatboolean or null

Indicates whether the value is inclusive of VAT, relevant for fixed price effects

Changedstring or null

The date and time when this promotion effect product list was last changed.

ChangedBystring or null

The identifier of the user who last changed this promotion effect product list.

{ "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, "IsDiscount": true, "IsFixedPrice": true, "Value": 0, "IsIncVat": true, "Changed": "string", "ChangedBy": "string" }

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

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