The Norce Management API lets you manage configurations and metadata on a client.
The Norce Management API lets you manage configurations and metadata on a client.
https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/
PromotionRequirementSetting model, represents the settings for a specific promotion requirement. Defines the type of requirement, its parameters, and associated product filters, if any.
Requirement type can have one of the following values: BasketTotal, ProductFilter, ProductManufacturer, ProductCategory, ProductFlag, ProductPriceList, ProductType, DiscountCode, UniqueDiscountCode, CustomerFlag, CompanyFlag
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.
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.
The order sum value for this requirement, applicable when the requirement type is BasketTotal. Can be null for other requirement types.
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.
Specify how to validate the order sum. True for validating including VAT, false for excluding VAT.
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".
The customer flag identifier associated with this requirement, applicable when the requirement type is CustomerFlag. Can be null for other requirement types.
The customer flag name associated with this requirement, applicable when the requirement type is CustomerFlag. Can be null for other requirement types.
Indicates whether the customer flag rule is "set" or "not set" for this requirement.
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.
The identifier of the user who last changed this promotion requirement setting.
Indicates whether the requirement should match by each part number individually when validating product filter list.
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.
{ "Id": 0, "RequirementType": "string", "DiscountCode": "string", "ValueType": "string", "OrderSum": 0, "OrderSumMax": 0, "IsIncVat": true, "ProductsIncluded": "string", "CustomerFlagId": 0, "CustomerFlagName": "string", "IsCustomerFlagIncluded": true, "SortOrder": 0, "ProductList": [ { … } ], "Changed": "string", "ChangedBy": "string", "MatchByEachPartNo": true, "GenericQty": 0, "GenericQtyMax": 0 }
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.
The manufacturer filter for this product rule, null if not filtering by manufacturer
The manufacturer code for this product rule, null if not filtering by manufacturer
The manufacturer name for this product rule, null if not filtering by manufacturer
The category filter for this product rule, null if not filtering by category
The category code for this product rule, null if not filtering by category
The category name for this product rule, null if not filtering by category
The price list filter for this product rule, null if not filtering by price list
The price list code for this product rule, null if not filtering by price list
The price list name for this product rule, null if not filtering by price list
The product type filter for this product rule, null if not filtering by product type
The product type code for this product rule, null if not filtering by product type
The product id filter for this product rule, null if not filtering by specific product
The product name for this product rule, null if not filtering by specific product
The variant product id filter for this product rule, null if not filtering by specific variant product
The variant product name for this product rule, null if not filtering by specific variant product
The quantity required for this product rule, null if applied on the requirement level
{ "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" }
PromotionEffectSetting model, represents the settings for a specific promotion effect. Defines the type of effect, its parameters, and associated product lists, if any.
Effect type can have one of the following values: DiscountBasket, ProductFilter, ProductManufacturer, ProductCategory, ProductFlag, ProductPriceList, ProductType, DiscountFreight, AddProduct, SelectProduct
The value associated with the effect, such as discount amount or fixed price
Indicates whether non-discountable items should be ignored in the effect calculation (when products or variants has IsDiscountable = false on the price record)
Indicates whether the discount should apply to the most expensive items first, relevant for product filter effects that discount a subset of valid products
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
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.
The list of product rules associated with this effect, applicable when the effect type involves product filtering
{ "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" }