Management API (v1)

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

Indicates whether the effect is calculated as a percentage discount

Indicates whether the effect is a fixed price adjustment

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

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

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

The sort order for displaying the effect in lists

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 date and time when this promotion effect setting was last changed.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

True if the product has variants.

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

The part number for the product or variant product

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

Indicates whether the effect is calculated as a percentage discount

Indicates whether the effect is a fixed price adjustment

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

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

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

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

The name of the promotion in the current culture

The default name of the promotion used as fallback when no culture-specific name is available

Indicates whether the name is inherited from the default culture

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

Indicates whether the sub header is inherited from the default culture

The sub description of the promotion in the current culture

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 description of the promotion in the current 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

The unique identifier for the promotion image

The URL of the promotion image, deprecated, use ImageKey instead.

The unique code identifying the promotion

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 maximum number of times this promotion can be used

The total number of times this promotion has been used

The number of unique users who have used this promotion

The number of unique discount codes associated with this promotion

The number of unique discount codes that have been used for this promotion

The total order amount for this promotion

The total discount amount given by this promotion

The discount percentage applied by this promotion

The margin percentage 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.

Promotion status: Inactive, Active, Draft. Default is Inactive

The currency code for this promotion

The date and time when the promotion was stopped

The identifier of the user who stopped this promotion

The name of the user who stopped this promotion

The date and time when the promotion was created

The name of the user who created this promotion

The date and time when the promotion was last changed

Fullname or Systemname of the user who last changed the promotion