Skip to content

Latest commit

 

History

History
47 lines (36 loc) · 4.82 KB

AdditionalCampaignProperties.md

File metadata and controls

47 lines (36 loc) · 4.82 KB

AdditionalCampaignProperties

Properties

Name Type Description Notes
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 Integer This property is deprecated. The count should be available under budgets property. Number of coupons redeemed in the campaign. [optional]
referralRedemptionCount Integer This property is deprecated. The count should be available under budgets property. Number of referral codes redeemed in the campaign. [optional]
discountCount BigDecimal This property is deprecated. The count should be available under budgets property. Total amount of discounts redeemed in the campaign. [optional]
discountEffectCount Integer This property is deprecated. The count should be available under budgets property. Total number of times discounts were redeemed in this campaign. [optional]
couponCreationCount Integer This property is deprecated. The count should be available under budgets property. Total number of coupons created by rules in this campaign. [optional]
customEffectCount Integer 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 Integer This property is deprecated. The count should be available under budgets property. Total number of referrals created by rules in this campaign. [optional]
addFreeItemEffectCount Integer 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 Integer This property is deprecated. The count should be available under budgets property. Total number of giveaways awarded by rules in this campaign. [optional]
createdLoyaltyPointsCount BigDecimal 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 Integer 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 BigDecimal 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 Integer 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 Integer This property is deprecated. The count should be available under budgets property. Total number of webhooks triggered by rules in this campaign. [optional]
reservecouponEffectCount Integer 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 OffsetDateTime Timestamp of the most recent event received by this campaign. [optional]
updated OffsetDateTime 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 Integer The ID of the Campaign Template this Campaign was created from. [optional]
frontendState FrontendStateEnum The campaign state displayed in the Campaign Manager.
storesImported Boolean Indicates whether the linked stores were imported via a CSV file.

Enum: FrontendStateEnum

Name Value
EXPIRED "expired"
SCHEDULED "scheduled"
RUNNING "running"
DISABLED "disabled"
ARCHIVED "archived"
STAGED "staged"