SpecialOffer

interface SpecialOffer
{
    id: string;
    description: TranslationText;
    imageUrl: TranslationText;
    dateBegin: Date;
    dateEnd: Date;
    minCountLocal: number;
    minValueLocal: number;
    minCountGlobal: number;
    minValueGlobal: number;
    discountFactor: number;
    products: Product[];
    subProducts: Product[];
}

Properties

Parameters

Name	Type	Description
id	string	Special offer ID
description	TranslationText	Multilingual description of the special offer.
imageUrl	TranslationText	URL to the promotion logo for different languages. The logo should be in the shape of a square with dimensions 42x42 pixels.
dateBegin	Date	Start date of the special offer in the format YYYY-MM-DD.
dateEnd	Date	End date of the special offer in the format YYYY-MM-DD.
minCountLocal	number	(optional) Minimum quantity of products required to activate the special offer within this special offer.
minValueLocal	number	(optional) Minimum total price of products required to activate the special offer within this special offer.
minCountGlobal	number	(optional) Minimum quantity of products required to activate the special offer across all special offers.
minValueGlobal	number	(optional) Minimum total price of products required to activate the special offer across all special offers.
discountFactor	number	Discount factor applied to the offer. For example, if the discount is 20%, you would enter 0.8.
products	Product	Array of products associated with the special offer. These are products that are specific to this special offer, such as kitchen cabinet fronts from a particular collection.
subProducts	Product	(optional) Array of sub-products associated with the special offer. These are products that appear in various special offers, such as kitchen cabinet bodies present in multiple collections.

Description

Special offer parameters.