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://{slug}.api-se.playground.norce.tech/commerce/
https://{slug}.api-se.stage.norce.tech/commerce/
https://{slug}.api-se.norce.tech/commerce/
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.1, "IsIncVat": true, "IgnoreNonDiscountable": true, "DiscountMostExpensiveItems": true, "SortOrder": 0, "UseRequirementProducts": true, "GenericQty": 0.1, "ProductList": [ { … } ], "Changed": "string", "ChangedBy": "string" }
Represents a list model for promotions, including various localized fields and settings, except for requirements and effects. Promotions are used to define discounts and special offers that are automatically applied on baskets during the purchase process.
The default name of the promotion used as fallback when no culture-specific name is available
The sub header of the promotion in the current culture
The default sub header of the promotion used as fallback when no culture-specific sub header is available
The default sub description of the promotion used as fallback when no culture-specific sub description is available
Indicates whether the sub description is inherited from the default culture
The description header of the promotion in the current culture
The default description header of the promotion used as fallback when no culture-specific description header is available
Indicates whether the description header is inherited from the default culture
The default description of the promotion used as fallback when no culture-specific description is available
Indicates whether the description is inherited from the default culture
Exclusive promotion type: NotExclusive, Exclusive, IgnoreExclusivity. Default is NotExclusive
The start date when the promotion becomes active, null means active immediately, if status is Active and start date is in the future the promotion is considered "Coming"
The end date when the promotion expires, null means no end date, if status is Active and end date is in the past the promotion is considered "Ended"
The number of usages left for this promotion, if AllowedUsageCount is set
The number of unique discount codes associated with this promotion
The number of unique discount codes that have been used for this promotion
Indicates whether this promotion can be stacked with itself. If true, multiples of the same promotion can be applied, like 3 for 2 deals (6 for 4, etc.). If false, the promotion can only be applied once per order.
Indicates whether this promotions products can be listed from API calls. If true, products can be listed in a front-end application when building a promotion bundle configuration UI. like choose products to buy with this promotion.
Indicates whether this promotion should be excluded from basket total price, so that other promotions are not validated based on the discounted price from this promotion.
{ "Id": 0, "Name": "string", "DefaultName": "string", "IsNameInherited": true, "SubHeader": "string", "DefaultSubHeader": "string", "IsSubHeaderInherited": true, "SubDescription": "string", "DefaultSubDescription": "string", "IsSubDescriptionInherited": true, "DescriptionHeader": "string", "DefaultDescriptionHeader": "string", "IsDescriptionHeaderInherited": true, "Description": "string", "DefaultDescription": "string", "IsDescriptionInherited": true, "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c", "ImageUrl": "string", "Code": "string", "ExclusivityType": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "CountLeft": 0, "AllowedUsageCount": 0, "UsageCount": 0, "UniqueUserUsageCount": 0, "UniqueDiscountCodeCount": 0, "UniqueDiscountCodeUsedCount": 0, "TotalOrder": 0.1, "TotalDiscount": 0.1, "DiscountPercentage": 0.1, "MarginPercentage": 0.1, "IsStackable": true, "IsProductReq": true, "ExcludeFromPriceCalculation": true, "Status": "string", "CurrencyCode": "string", "StoppedDate": "2019-08-24T14:15:22Z", "StoppedBy": 0, "StoppedByName": "string", "Created": "2019-08-24T14:15:22Z", "CreatedByName": "string", "Changed": "string", "ChangedBy": "string", "Cultures": [ { … } ] }
Represents a detailed model for promotions, including requirements and effects, in addition to the fields provided in PromotionListModel. Promotions are used to define discounts and special offers that are automatically applied on baskets during the purchase process.
The list of requirements that must be met for this promotion to be applied
The list of effects that will be applied when this promotion is triggered
The default name of the promotion used as fallback when no culture-specific name is available
The sub header of the promotion in the current culture
The default sub header of the promotion used as fallback when no culture-specific sub header is available
The default sub description of the promotion used as fallback when no culture-specific sub description is available
Indicates whether the sub description is inherited from the default culture
The description header of the promotion in the current culture
The default description header of the promotion used as fallback when no culture-specific description header is available
Indicates whether the description header is inherited from the default culture
The default description of the promotion used as fallback when no culture-specific description is available
Indicates whether the description is inherited from the default culture
Exclusive promotion type: NotExclusive, Exclusive, IgnoreExclusivity. Default is NotExclusive
The start date when the promotion becomes active, null means active immediately, if status is Active and start date is in the future the promotion is considered "Coming"
The end date when the promotion expires, null means no end date, if status is Active and end date is in the past the promotion is considered "Ended"
The number of usages left for this promotion, if AllowedUsageCount is set
The number of unique discount codes associated with this promotion
The number of unique discount codes that have been used for this promotion
Indicates whether this promotion can be stacked with itself. If true, multiples of the same promotion can be applied, like 3 for 2 deals (6 for 4, etc.). If false, the promotion can only be applied once per order.
Indicates whether this promotions products can be listed from API calls. If true, products can be listed in a front-end application when building a promotion bundle configuration UI. like choose products to buy with this promotion.
Indicates whether this promotion should be excluded from basket total price, so that other promotions are not validated based on the discounted price from this promotion.
{ "Requirements": [ { … } ], "Effects": [ { … } ], "Id": 0, "Name": "string", "DefaultName": "string", "IsNameInherited": true, "SubHeader": "string", "DefaultSubHeader": "string", "IsSubHeaderInherited": true, "SubDescription": "string", "DefaultSubDescription": "string", "IsSubDescriptionInherited": true, "DescriptionHeader": "string", "DefaultDescriptionHeader": "string", "IsDescriptionHeaderInherited": true, "Description": "string", "DefaultDescription": "string", "IsDescriptionInherited": true, "ImageKey": "9afa8b7e-ca15-438f-a9d6-f679c437e59c", "ImageUrl": "string", "Code": "string", "ExclusivityType": "string", "StartDate": "2019-08-24T14:15:22Z", "EndDate": "2019-08-24T14:15:22Z", "CountLeft": 0, "AllowedUsageCount": 0, "UsageCount": 0, "UniqueUserUsageCount": 0, "UniqueDiscountCodeCount": 0, "UniqueDiscountCodeUsedCount": 0, "TotalOrder": 0.1, "TotalDiscount": 0.1, "DiscountPercentage": 0.1, "MarginPercentage": 0.1, "IsStackable": true, "IsProductReq": true, "ExcludeFromPriceCalculation": true, "Status": "string", "CurrencyCode": "string", "StoppedDate": "2019-08-24T14:15:22Z", "StoppedBy": 0, "StoppedByName": "string", "Created": "2019-08-24T14:15:22Z", "CreatedByName": "string", "Changed": "string", "ChangedBy": "string", "Cultures": [ { … } ] }