| Id |
int |
Unique ID for this entity. |
|
| Created |
DateTime |
The exact moment this entity was created. |
|
| ApplicationId |
int |
The ID of the application that owns this entity. |
|
| UserId |
int |
The ID of the user associated with this entity. |
|
| Name |
string |
A user-facing name for this campaign. |
|
| Description |
string |
A detailed description of the campaign. |
|
| StartTime |
DateTime |
Timestamp when the campaign will become active. |
[optional] |
| EndTime |
DateTime |
Timestamp when the campaign will become inactive. |
[optional] |
| Attributes |
Object |
Arbitrary properties associated with this campaign. |
[optional] |
| State |
string |
A disabled or archived campaign is not evaluated for rules or coupons. |
[default to StateEnum.Enabled] |
| ActiveRulesetId |
int |
ID of Ruleset this campaign applies on customer session evaluation. |
[optional] |
| Tags |
List<string> |
A list of tags for the campaign. |
|
| Features |
List<string> |
The features enabled in this campaign. |
|
| CouponSettings |
CodeGeneratorSettings |
|
[optional] |
| ReferralSettings |
CodeGeneratorSettings |
|
[optional] |
| Limits |
List<LimitConfig> |
The set of budget limits for this campaign. |
|
| CampaignGroups |
List<int> |
The IDs of the campaign groups this campaign belongs to. |
[optional] |
| Type |
string |
The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items. |
[default to TypeEnum.Advanced] |
| LinkedStoreIds |
List<int> |
A list of store IDs that you want to link to the campaign. Note: Campaigns with linked store IDs will only be evaluated when there is a customer session update that references a linked store. |
[optional] |
| Budgets |
List<CampaignBudget> |
A list of all the budgets that are defined by this campaign and their usage. Note: Budgets that are not defined do not appear in this list and their usage is not counted until they are defined. |
|
| CouponRedemptionCount |
int |
This property is deprecated. The count should be available under budgets property. Number of coupons redeemed in the campaign. |
[optional] |
| ReferralRedemptionCount |
int |
This property is deprecated. The count should be available under budgets property. Number of referral codes redeemed in the campaign. |
[optional] |
| DiscountCount |
decimal |
This property is deprecated. The count should be available under budgets property. Total amount of discounts redeemed in the campaign. |
[optional] |
| DiscountEffectCount |
int |
This property is deprecated. The count should be available under budgets property. Total number of times discounts were redeemed in this campaign. |
[optional] |
| CouponCreationCount |
int |
This property is deprecated. The count should be available under budgets property. Total number of coupons created by rules in this campaign. |
[optional] |
| CustomEffectCount |
int |
This property is deprecated. The count should be available under budgets property. Total number of custom effects triggered by rules in this campaign. |
[optional] |
| ReferralCreationCount |
int |
This property is deprecated. The count should be available under budgets property. Total number of referrals created by rules in this campaign. |
[optional] |
| AddFreeItemEffectCount |
int |
This property is deprecated. The count should be available under budgets property. Total number of times the add free item effect can be triggered in this campaign. |
[optional] |
| AwardedGiveawaysCount |
int |
This property is deprecated. The count should be available under budgets property. Total number of giveaways awarded by rules in this campaign. |
[optional] |
| CreatedLoyaltyPointsCount |
decimal |
This property is deprecated. The count should be available under budgets property. Total number of loyalty points created by rules in this campaign. |
[optional] |
| CreatedLoyaltyPointsEffectCount |
int |
This property is deprecated. The count should be available under budgets property. Total number of loyalty point creation effects triggered by rules in this campaign. |
[optional] |
| RedeemedLoyaltyPointsCount |
decimal |
This property is deprecated. The count should be available under budgets property. Total number of loyalty points redeemed by rules in this campaign. |
[optional] |
| RedeemedLoyaltyPointsEffectCount |
int |
This property is deprecated. The count should be available under budgets property. Total number of loyalty point redemption effects triggered by rules in this campaign. |
[optional] |
| CallApiEffectCount |
int |
This property is deprecated. The count should be available under budgets property. Total number of webhooks triggered by rules in this campaign. |
[optional] |
| ReservecouponEffectCount |
int |
This property is deprecated. The count should be available under budgets property. Total number of reserve coupon effects triggered by rules in this campaign. |
[optional] |
| LastActivity |
DateTime |
Timestamp of the most recent event received by this campaign. |
[optional] |
| Updated |
DateTime |
Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are not registered by this property, such as collection or coupon updates. |
[optional] |
| CreatedBy |
string |
Name of the user who created this campaign if available. |
[optional] |
| UpdatedBy |
string |
Name of the user who last updated this campaign if available. |
[optional] |
| TemplateId |
int |
The ID of the Campaign Template this Campaign was created from. |
[optional] |
| FrontendState |
string |
A campaign state described exactly as in the Campaign Manager. |
|
| StoresImported |
bool |
Indicates whether the linked stores were imported via a CSV file. |
|
| ActiveRevisionId |
int |
ID of the revision that was last activated on this campaign. |
[optional] |
| ActiveRevisionVersionId |
int |
ID of the revision version that is active on the campaign. |
[optional] |
| Version |
int |
Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. |
[optional] |
| CurrentRevisionId |
int |
ID of the revision currently being modified for the campaign. |
[optional] |
| CurrentRevisionVersionId |
int |
ID of the latest version applied on the current revision. |
[optional] |
| StageRevision |
bool |
Flag for determining whether we use current revision when sending requests with staging API key. |
[optional] [default to false] |