Skip to content

Latest commit

 

History

History
116 lines (72 loc) · 8.13 KB

Campaign.md

File metadata and controls

116 lines (72 loc) · 8.13 KB
Raw

TalonOne.Campaign

Properties

Name Type Description Notes
id Number Unique ID for this entity.
created Date The exact moment this entity was created.
applicationId Number The ID of the application that owns this entity.
userId Number 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 Date Timestamp when the campaign will become active. [optional]
endTime Date 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 'enabled']
activeRulesetId Number ID of Ruleset this campaign applies on customer session evaluation. [optional]
tags [String] A list of tags for the campaign.
features [String] The features enabled in this campaign.
couponSettings CodeGeneratorSettings [optional]
referralSettings CodeGeneratorSettings [optional]
limits [LimitConfig] The set of budget limits for this campaign.
campaignGroups [Number] 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 'advanced']
linkedStoreIds [Number] 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 [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 Number This property is deprecated. The count should be available under budgets property. Number of coupons redeemed in the campaign. [optional]
referralRedemptionCount Number This property is deprecated. The count should be available under budgets property. Number of referral codes redeemed in the campaign. [optional]
discountCount Number This property is deprecated. The count should be available under budgets property. Total amount of discounts redeemed in the campaign. [optional]
discountEffectCount Number This property is deprecated. The count should be available under budgets property. Total number of times discounts were redeemed in this campaign. [optional]
couponCreationCount Number This property is deprecated. The count should be available under budgets property. Total number of coupons created by rules in this campaign. [optional]
customEffectCount Number 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 Number This property is deprecated. The count should be available under budgets property. Total number of referrals created by rules in this campaign. [optional]
addFreeItemEffectCount Number 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 Number This property is deprecated. The count should be available under budgets property. Total number of giveaways awarded by rules in this campaign. [optional]
createdLoyaltyPointsCount Number 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 Number 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 Number 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 Number 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 Number This property is deprecated. The count should be available under budgets property. Total number of webhooks triggered by rules in this campaign. [optional]
reservecouponEffectCount Number 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 Date Timestamp of the most recent event received by this campaign. [optional]
updated Date 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 Number 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 Boolean Indicates whether the linked stores were imported via a CSV file.
activeRevisionId Number ID of the revision that was last activated on this campaign. [optional]
activeRevisionVersionId Number ID of the revision version that is active on the campaign. [optional]
version Number Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign. [optional]
currentRevisionId Number ID of the revision currently being modified for the campaign. [optional]
currentRevisionVersionId Number ID of the latest version applied on the current revision. [optional]
stageRevision Boolean Flag for determining whether we use current revision when sending requests with staging API key. [optional] [default to false]

Enum: StateEnum

  • enabled (value: "enabled")

  • disabled (value: "disabled")

  • archived (value: "archived")

Enum: [FeaturesEnum]

  • coupons (value: "coupons")

  • referrals (value: "referrals")

  • loyalty (value: "loyalty")

  • giveaways (value: "giveaways")

  • strikethrough (value: "strikethrough")

  • achievements (value: "achievements")

Enum: TypeEnum

  • cartItem (value: "cartItem")

  • advanced (value: "advanced")

Enum: FrontendStateEnum

  • expired (value: "expired")

  • scheduled (value: "scheduled")

  • running (value: "running")

  • disabled (value: "disabled")

  • archived (value: "archived")