You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
Promotion
Representation of a Promotion Promotion
export interface Promotion {
'code'?: string;
'couldFireMessages'?: Array<string>;
'description'?: string;
'enabled'?: boolean;
'endDate'?: string;
'firedMessages'?: Array<string>;
'priority'?: number;
'productBanner'?: Image;
'promotionGroup'?: string;
'promotionType'?: string;
'restrictions'?: Array<PromotionRestriction>;
'startDate'?: string;
'title'?: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
code | Optional | string | Code of the promotion {string} Promotion |
couldFireMessages | Optional | Array<string> | Message about promotion which is displayed when planning potential promotion. This field has higher priority over promotion description {Array<string>} Promotion |
description | Optional | string | Description of the promotion {string} Promotion |
enabled | Optional | boolean | Boolean flag if promotion is enabled {boolean} Promotion |
endDate | Optional | string | Last date of validity of the promotion {string} Promotion |
firedMessages | Optional | Array<string> | Message fired while the promotion is active. This is info how much you will get when applying the promotion {Array<string>} Promotion |
priority | Optional | number | Priority index as numeric value of the promotion. Higher number means higher priority {number} Promotion |
productBanner | Optional | Image | {Image} Promotion |
promotionGroup | Optional | string | Group of the promotion {string} Promotion |
promotionType | Optional | string | Type of the promotion {string} Promotion |
restrictions | Optional | Array<PromotionRestriction> | List of promotion restrictions {Array<PromotionRestriction>} Promotion |
startDate | Optional | string | The initial date of the promotion {string} Promotion |
title | Optional | string | Promotion title {string} Promotion |