| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
Server-side incremental ID |
integer |
None. |
| StoreID | integer |
Deprecated. |
|
| Name | string |
Required String length: inclusive between 0 and 64 |
|
| NameGuid | globally unique identifier |
None. |
|
| Description | string |
String length: inclusive between 0 and 255 |
|
| ShowDiscounts |
Show the discounts on screen/receipt |
boolean |
None. |
| ShowTotals |
Show discount totals on receipt |
boolean |
None. |
| OnlyEvaluateOnSubtotal | boolean |
None. |
|
| UseDescription |
When showing discounts, use campaign description |
boolean |
None. |
| CampaignType | CampaignType |
None. |
|
| StartDate | date |
Data type: Date |
|
| StartTime | integer |
None. |
|
| EndDate |
Defaults to DateTime.MaxValue at the POS ? |
date |
Data type: Date |
| EndTime | integer |
None. |
|
| Recurrence | integer |
None. |
|
| RecurrenceType | CampaignScheduleType |
None. |
|
| MonthType | CampaignMonthlyType |
None. |
|
| WeekDays | CampaignDayOfWeek |
None. |
|
| Months | CampaignMonth |
None. |
|
| MonthWeeks | CampaignWeekOfMonth |
None. |
|
| MonthDays | string |
String length: inclusive between 0 and 32 |
|
| Printed | boolean |
None. |
|
| TalkerText | string |
None. |
|
| RangeDescription | string |
None. |
|
| DealDescription | string |
None. |
|
| LabelQuantity | integer |
None. |
|
| Active | integer |
None. |
|
| Deactivated | date |
None. |
|
| System |
Inidcates that the Campaign is critical for business operations |
boolean |
None. |
| Created | date |
None. |
|
| Updated | date |
None. |
|
| PriceChangeNotifiedUtc | date |
None. |
|
| PromoType |
Refers to the sale prmo type (Normal, Promo or In-store) |
PromoType |
None. |
| PromotionTypeCode |
PromotionType Code from promotion type field |
string |
None. |
| HostIdentifier |
Host Identifier for PromotionTypeCode, only filled when FromHost is true |
Collection of byte |
None. |
| HostIdentifierGuid | globally unique identifier |
None. |
|
| HostType | HostType |
None. |
|
| CreatedByUser | string |
String length: inclusive between 0 and 255 |
|
| FromHost | boolean |
None. |
|
| Deleted | boolean |
None. |
|
| CampaignDeleted | date |
None. |
|
| UpdatedByUser | string |
String length: inclusive between 0 and 255 |
|
| OfferID | integer |
None. |
|
| IsPriceChangeCampaign | boolean |
None. |
|
| Stores | Collection of integer |
Relation. This field may not always be loaded or used for updates. |
|
| StoreNames | Collection of string |
Relation. This field may not always be loaded or used for updates. |
|
| CampaignPlus | Collection of CampaignPlu |
Relation. This field may not always be loaded or used for updates. |
|
| CampaignPools | Collection of CampaignPool |
Relation. This field may not always be loaded or used for updates. |
|
| SellingRules | Collection of SellingRule |
Relation. This field may not always be loaded or used for updates. |
|
| Customers | Collection of CampaignCustomer |
Relation. This field may not always be loaded or used for updates. |
|
| CustomerGroups | Collection of CampaignCustomerGroup |
Relation. This field may not always be loaded or used for updates. |
|
| SignIqTickets | Collection of CampaignSignIqTicket |
Relation. This field may not always be loaded or used for updates. |
|
| ComboPriceGroups | Collection of ComboPriceGroup |
Relation. This field may not always be loaded or used for updates. |
|
| PriceLevels | Collection of CampaignPriceLevel |
Relation. This field may not always be loaded or used for updates. |