The identity and technical contract details declared by the specification.
RollbackReferralEffectProps
object
This effect indicates that the redemption of the referral code has been rolled back. It triggers when a closed session that redeemed a referral is gets cancell…
1 property
1 required
SetDiscountEffectProps
object
This effect indicates that a discount should be set on the total shopping cart value of the current order with the given label and amount. The discount should…
4 properties
2 required
AcceptReferralEffectProps
object
This effect indicates that the referral code supplied is valid. You should handle this effect by informing the user that the referral code is valid. The code i…
1 property
1 required
RedeemReferralEffectProps
object
This effect is deprecated. It has been replaced by the acceptReferral effect. This effect indicates that the referral code is valid and has been redeemed.
2 properties
2 required
NewEventV3Entity
object
1 property
1 required
AcceptCouponEffectProps
object
This effect indicates that the coupon code supplied was valid. You should handle this effect by clearing any messages from previous rejectCoupon effects and in…
1 property
1 required
UpdateLoyaltyCard
object
2 properties
1 required
ResponseContentObject
object
1 property
EvaluableCampaignIds
object
1 property
UserEntity
object
1 property
1 required
EventV3Entity
object
1 property
LoyaltyLedgerEntryExpiryDateChange
object
The properties specific to effects for changing the expiry dates of loyalty ledger entries.
3 properties
2 required
RejectCouponEffectProps
object
This effect indicates that the coupon code supplied couldn't be used. You should handle this effect by informing their user the coupon code is invalid.
6 properties
2 required
IntegrationEventV3Request
ErrorResponseWithStatus
object
3 properties
WillAwardGiveawayEffectProps
object
The equivalent of the awardGiveaway effect but returned when updating a session with any state other than closed. This ensures no giveaway codes are leaked whe…
3 properties
3 required
CampaignEligibilityFailureDetails
object
The details about why the customer was not eligible for the campaign in the current session.
1 property
1 required
CouponEntity
object
2 properties
2 required
RuleMetadata
object
4 properties
1 required
RollbackIncreasedAchievementProgressEffectProps
object
This effect indicates that the customer's progress in an achievement was rolled back. The Rule Engine triggers this effect when you cancel or [reopen a custome…
6 properties
6 required
TriggerWebhookEffectProps
object
This effect is triggered when a rule containing a [webhook effect](https://docs.talon.one/docs/product/rules/effects/available-effectswebhooks) is validated. T…
2 properties
2 required
IncreaseAchievementProgressEffectProps
object
This effect indicates that the customer's progress in an achievement was updated during the current session. It is triggered when a rule using the [Update cust…
7 properties
6 required
IntegrationProfileEntityV3
object
1 property
1 required
IntegrationEventV3Response
CouponCreatedEffectProps
object
This effect indicates that a coupon was created. For referrals and retention marketing, a common use case is to generate a coupon that can only be redeemed by…
2 properties
2 required
LimitConfig
object
4 properties
3 required
RuleEligibility
object
The customer's eligibility for a rule in the current session, based on whether all of the rule's conditions were met.
3 properties
1 required
LoyaltyMembership
object
2 properties
1 required
RollbackDeductedLoyaltyPointsEffectProps
object
This effect is triggered in the following cases: - A session is cancelled and this session deducted loyalty points. The rollback action returns the redeemed lo…
8 properties
5 required
ErrorEffectProps
object
This effect is triggered whenever an error occurs during rule evaluation. This effect only provides information about what the error is.
1 property
1 required
EntityWithTalangVisibleID
object
2 properties
2 required
IntegrationEventV2Request
RuleFailureReason
object
Details about why a rule failed.
14 properties
5 required
RemoveFromAudienceEffectProps
object
This effect is triggered when a rule containing an [Update audience](https://docs.talon.one/docs/product/rules/effects/use-effectsupdate-an-audience) effect wi…
4 properties
EventV3Connections
object
1 property
LoyaltyProgramLedgers
object
Customer-specific information about loyalty points.
6 properties
4 required
DeductLoyaltyPointsEffectProps
object
This effect is triggered when a customer redeems loyalty points. The points are deducted from their active point balance. If the loyalty program is card-based,…
7 properties
6 required
CouponRejectionReason
object
Holds a reference to the campaign, the coupon and the reason for which that coupon was rejected. Should only be present when there is a 'rejectCoupon' effect.
3 properties
3 required
SetDiscountPerAdditionalCostPerItemEffectProps
object
This effect indicates that a discount of a specific additional cost within a specific item should be applied. It gets triggered whenever a rule containing a Di…
7 properties
5 required
RejectReferralEffectProps
object
This effect indicates that the provided referral code is invalid.
6 properties
2 required
LoyaltyProgramEntity
object
3 properties
1 required
CustomerAchievement
object
A customer's progress in an achievement, together with the achievement definition.
11 properties
9 required
CouponValue
object
1 property
SetLoyaltyPointsExpiryDateEffectProps
object
This effect updates the expiry date of all active, pending, and unlimited point transactions to a specific date.
4 properties
3 required
CampaignBudget
object
3 properties
3 required
CampaignEligibilityDetails
object
3 properties
1 required
ReferralConstraints
object
3 properties
CampaignVersions
object
7 properties
ShowBundleMetadataEffectProps
object
This effect is deprecated. The ShowBundleMetadata effect contains information that allows you to associate the discounts from a rule in a bundle campaign with…
3 properties
3 required
AddToAudienceEffectProps
object
This effect is triggered when a rule containing an [Update audience](https://docs.talon.one/docs/product/rules/effects/use-effectsupdate-an-audience) effect wi…
4 properties
AchievementProgress
object
The current progress of the customer in the achievement.
5 properties
2 required
IntegrationEventV2Response
IntegrationEntity
object
2 properties
2 required
SetDiscountPerItemEffectProps
object
This effect schema is returned when you use the Discount individual items, Discount individual items pro rata, or Discount individual item in bundles effect in…
13 properties
3 required
Entity
object
2 properties
2 required
StartAchievementProgressEffectProps
object
This effect indicates that the customer's progress in an achievement was started during the current session. The progress value is set to 0. It is triggered wh…
6 properties
5 required
ApplicationEntity
object
1 property
1 required
CustomEffectProps
object
If you want to return data as an effect but no effect matches your use case, you can [create a custom effect](https://docs.talon.one/docs/dev/tutorials/create-…
7 properties
3 required
AddFreeItemEffectProps
object
This effect indicates that a free item should be added to the shopping cart in the current session. In this example, add the SKU to the shopping cart and set i…
3 properties
2 required
CustomerProfileEntity
object
2 properties
2 required
AddLoyaltyPointsEffectProps
object
This effect indicates that a defined amount of loyalty points was successfully added to the customer's profile or to a loyalty card. If you use the [Add loyalt…
16 properties
6 required
RollbackAddedLoyaltyPointsEffectProps
object
This effect is triggered in the following cases: - A session was cancelled in which loyalty points have been added. - A session was partially returned and loya…
8 properties
5 required
AdditionalCampaignProperties
object
25 properties
5 required
Tier
object
5 properties
2 required
ReferralRejectionReason
object
Holds a reference to the campaign, the referral and the reason for which that referral was rejected. Should only be present when there is a 'rejectReferral' ef…
3 properties
3 required
RollbackDiscountEffectProps
object
This effect indicates that a discounted session, cart item, or additional cost has been cancelled or partially returned. This effect can only happen when you s…
7 properties
2 required
RuleEligibilityFailureDetails
object
The details about why the customer was not eligible for the rule in the current session.
8 properties
2 required
AwardGiveawayEffectProps
object
This effect indicates the awarded giveaway item and to which profile the item was awarded. Learn more about [giveaways](https://docs.talon.one/docs/product/giv…
5 properties
5 required
Loyalty
object
Customer-specific information about loyalty points.
2 properties
1 required
IntegrationResponse
object
Contains entities that might be valuable in Talon.One integrations.
10 properties
3 required
APIError
object
3 properties
2 required
EventAttributesEntity
object
2 properties
1 required
LoyaltyCardProfileRegistration
object
2 properties
2 required
EffectEntity
object
Definition of all properties that are present on all effects, independent of their type.
16 properties
5 required
CouponLimitConfigs
object
1 property
CouponConstraints
object
5 properties
SetDiscountPerAdditionalCostEffectProps
object
This effect indicates that a discount that should be applied on a specific additional cost. It is triggered whenever a rule containing a Discount additional co…
5 properties
4 required
BaseCampaign
object
17 properties
5 required
ReferralCreatedEffectProps
object
The referralCreated effect behaves similarly to [couponCreated](https://docs.talon.one/docs/dev/integration-api/api-effectscouponcreated). If the friendProfile…
1 property
1 required
ReserveCouponEffectProps
object
This effect indicates that the given coupon code was reserved for the given customer. Talon.One provides soft and hard reservations. For more information, see…
3 properties
3 required
NewCustomerProfile
object
1 property
ChangeLoyaltyTierLevelEffectProps
object
This effect indicates that a customer's loyalty tier has been upgraded. This effect is generated only when the [Add loyalty points](https://docs.talon.one/docs…
6 properties
4 required
CampaignEntity
object
1 property
1 required
CampaignEligibilityExperiment
object
The identifiers for the [experiment](https://docs.talon.one/management-apitag/Experiments) and the variant assigned to the customer profile. Only returned when…
2 properties
2 required
CodeGeneratorSettings
object
2 properties
2 required
IntegrationStoreEntity
object
1 property
IntegrationProfileEntity
object
1 property
LoyaltyCardIdentifier
string
The identifier of the loyalty card, which must match the regular expression ^[A-Za-z0-9.%+@-]+$.
UpdateAttributeEffectProps
object
This effect indicates that a rule containing an [Update attribute value](https://docs.talon.one/docs/product/rules/effects/available-effectsupdate-effects) or…
2 properties
2 required
ImportEntity
object
1 property
ErrorSource
object
The source of the current error, exactly one of pointer, parameter or line will be defined.
4 properties
ShowNotificationEffectProps
object
You can use notifications to inform customers of certain events. There are four types of notification messages: - Info - Offer - Error - Misc It is up to you t…
3 properties
3 required
ExtendLoyaltyPointsExpiryDateEffectProps
object
If loyalty points have an expiry date, this effect extends the expiry of all active and pending point transactions by a selected duration.
4 properties
4 required
RollbackCouponEffectProps
object
This effect indicates that a coupon code redemption has been rolled back. The coupon becomes redeemable again. The effect is triggered when you [cancel](https:…
1 property
1 required
AudienceMembership
object
2 properties
2 required
LoyaltyProgramBalance
object
The balance in a Loyalty Program for some Customer.
8 properties
5 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Talon.One publishes across the network.
