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/
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.
The list of culture-specific translations for this promotion
The list of requirements that must be met for this promotion to be applied
{ "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": "string", "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, "TotalDiscount": 0, "DiscountPercentage": 0, "MarginPercentage": 0, "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": [ { … } ], "Requirements": [ { … } ], "Effects": [ { … } ] }
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" }