--- title: "List Applications events" method: GET path: "/v1/applications/{applicationId}/events/no_total" tags: ["Customer data"] --- # List Applications events `GET /v1/applications/{applicationId}/events/no_total` ## Request - Base URL: `https://yourbaseurl.talon.one` - URL: `https://yourbaseurl.talon.one/v1/applications/{applicationId}/events/no_total` - Auth: one of: - API key in header `Authorization` - API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) > [!note] Management API endpoints are **not** meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second. Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results. ## Path parameters - `applicationId` integer, required ## Query parameters - `pageSize` integer - `skip` integer - `sort` string - `type` string - `createdBefore` string, date-time - `createdAfter` string, date-time - `session` string - `profile` string - `customerName` string - `customerEmail` string - `couponCode` string - `referralCode` string - `ruleQuery` string - `campaignQuery` string - `effectType` string ## Response `200` OK - object - `hasMore` boolean, required - `data` ApplicationEvent[], required - `id` integer, required: The internal ID of this entity. - `created` string, date-time, required: The time this entity was created. - `applicationId` integer, required: The ID of the Application that owns this entity. - `profileId` integer: The globally unique Talon.One ID of the customer that created this entity. - `storeId` integer: The ID of the store. - `storeIntegrationId` string: The integration ID of the store. You choose this ID when you create a store. - `integrationId` string: The unique ID of the event. Only one event with this ID can be registered. - `sessionId` integer: The globally unique Talon.One ID of the session that contains this event. - `type` string, required: The name of the event. Must be a [custom event](https://docs.talon.one/docs/dev/concepts/entities/events#custom-events), not a built-in event. - `attributes` object, required: Additional JSON serialized data associated with the event. - `effects` Effect[], required: An array containing the effects that were applied as a result of this event. - union - object: The `acceptCoupon` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'acceptCoupon', required: An effect discriminator of type `acceptCoupon`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` AcceptCouponEffectProps, required: This effect indicates that the coupon code supplied was valid. You should handle this effect by clearing any messages from previous `rejectCoupon` effects and informing the user that the coupon is valid. The code is automatically redeemed when you close the session. Other effects, such as [setDiscount](https://docs.talon.one/docs/dev/integration-api/api-effects#setdiscount), provide more information about the actual rewards received. - `value` string, required: The coupon code that was accepted. - object: The `acceptReferral` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'acceptReferral', required: An effect discriminator of type `acceptReferral`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` AcceptReferralEffectProps, required: 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 is automatically redeemed when you close the session. Other effects will provide more information about the actual reward. - `value` string, required: The referral code provided in the session. - object: The `addFreeItem` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'addFreeItem', required: An effect discriminator of type `addFreeItem`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` AddFreeItemEffectProps, required: 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 its price to `0`. - `sku` string, required: SKU of the item that needs to be added. - `name` string, required: Description of the effect. - `desiredQuantity` integer: The original quantity in case a partial reward was applied. - object: The `addLoyaltyPoints` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'addLoyaltyPoints', required: An effect discriminator of type `addLoyaltyPoints`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` AddLoyaltyPointsEffectProps, required: 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 loyalty points per item effect](https://docs.talon.one/docs/product/rules/effects/available-effects#reward-effects), use the `cartItemPosition` property to identify which item to add the loyalty points for. Enabling [partial rewards](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-rewards) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches 0. Use the `desiredValue` property to identify the original amount of loyalty points. If you use **Add loyalty points per item** and if the session contains some cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the item unit in its line item. See the example below for more information. If your list of cart items is a [bundle definition](https://docs.talon.one/docs/product/rules/create-and-manage-bundles), use the `bundleIndex` and `bundleName` properties to identify the bundle containing the items for which loyalty points are added. If you have set custom activation and expiration dates for the loyalty points, use the `startDate` and `expiryDate` properties to identify when the reward will be active and when will expire. If the loyalty program is [profile-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `recipientIntegrationId` property to identify the user who receives the loyalty points. If the loyalty program is [card-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `cardIdentifier` property to identify the loyalty card on which these points are added. The points only persist when the session is closed. - `name` string, required: The reason of this loyalty point addition. - `programId` integer, required: The ID of the loyalty program where these points were added. - `subLedgerId` string, required: The ID of the subledger within the loyalty program where these points were added. - `value` number, required: The amount of points that were added. - `desiredValue` number: (Partial rewards enabled only) The amount of loyalty points to be awarded without considering budget limitations. - `recipientIntegrationId` string, required: The user for whom these points were added. - `startDate` string, date-time: The date after which the added points will be valid. - `expiryDate` string, date-time: The date after which the added points will expire. - `transactionUUID` string, required: The identifier of this loyalty point transaction. - `cartItemPosition` number: (_Add points per cart item_ only.) The index of the item in the `cartItem` object for which these points were added. - `cartItemSubPosition` number: (_Add points per cart item_ ) The index of the item unit in its line item. - `cardIdentifier` string: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - `bundleIndex` integer: _(With bundles only)_ The position of the specific bundle in the list of bundles created from the same bundle definition. - `bundleName` string: _(With bundles only)_ The name of the bundle definition. - `awaitsActivation` boolean: Indicates whether the points have an action-based start date. This property is returned only for point transactions with an action-based start date. - `validityDuration` string: The duration for which the points remain active, calculated relative to their start date. - object: The `addNegativeLoyaltyPoints` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'addNegativeLoyaltyPoints', required: An effect discriminator of type `addNegativeLoyaltyPoints`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - object: The `addToAudience` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'addToAudience', required: An effect discriminator of type `addToAudience`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` AddToAudienceEffectProps, required: This effect is triggered when a rule containing an [Update audience](https://docs.talon.one/docs/product/rules/effects/use-effects#update-an-audience) effect with **Add customer to an audience** selected is validated. It indicates that a customer was added to an audience and is returned when a customer session is opened, updated, or closed. - `audienceId` integer: The internal ID of the audience. - `audienceName` string: The name of the audience. - `profileIntegrationId` string: The ID of the customer profile in the third-party integration platform. - `profileId` integer: The internal ID of the customer profile. - object: The `awardGiveaway` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'awardGiveaway', required: An effect discriminator of type `awardGiveaway`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` AwardGiveawayEffectProps, required: 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/giveaways/overview). - `poolId` integer, required: The internal ID of the giveaway pool. - `poolName` string, required: The name of the giveaway pool. - `recipientIntegrationId` string, required: The integration ID of the customer that receives the giveaway. - `giveawayId` integer, required: The internal ID of the giveaway. - `code` string, required: The giveaway code to be rewarded. - object: The `boostLoyaltyTier` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'boostLoyaltyTier', required: An effect discriminator of type `boostLoyaltyTier`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` BoostLoyaltyTierEffectProps, required: This effect indicates that the customer was temporarily placed in a higher loyalty tier for a specified period, without any change to their points balance. - `programId` integer, required: The ID of the loyalty program. - `subLedgerId` string, required: The ID of the subledger within the loyalty program. - `tierName` string, required: The name of the tier to which the customer is temporarily boosted. - `reason` string: A reason for the tier boost. - `expiryDate` string, date-time, required: The date when the tier boost expires. - `boostUuid` string, uuid, required: The unique identifier of the tier boost. Used to match the boost to its rollback effect when a session is cancelled. - object: The `callApi` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'callApi', required: An effect discriminator of type `callApi`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` TriggerWebhookEffectProps, required: This effect is triggered when a rule containing a [webhook effect](https://docs.talon.one/docs/product/rules/effects/available-effects#webhooks) is validated. The details are shared with you for your information only. It usually doesn't require an action on your side. - `webhookId` number, required: The internal ID of the webhook. - `webhookName` string, required: The name of the webhook. - object: The `changeLoyaltyTierLevel` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'changeLoyaltyTierLevel', required: An effect discriminator of type `changeLoyaltyTierLevel`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` ChangeLoyaltyTierLevelEffectProps, required: 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/product/rules/effects/use-effects#add-loyalty-points) and the [Add loyalty points per cart item](https://docs.talon.one/docs/product/rules/effects/use-effects#add-loyalty-points-per-cart-item) effects are triggered for a particular customer, and, as a result, the customer's loyalty tier is upgraded. - `ruleTitle` string, required: The title of the rule that triggered the tier upgrade. - `programId` integer, required: The ID of the loyalty program where the points were added. - `subLedgerId` string, required: The ID of the subledger within the loyalty program where the points were added. - `previousTierName` string: The name of the tier from which the user was upgraded. - `newTierName` string, required: The name of the tier to which the user has been upgraded. - `expiryDate` string, date-time: The expiration date of the new tier. - object: The `couponCreated` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'couponCreated', required: An effect discriminator of type `couponCreated`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` CouponCreatedEffectProps, required: 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 one specific customer. Handle this effect by notifying the recipient about their new coupon code. - `value` string, required: The coupon code that was created. - `profileId` string, required: The integration identifier of the customer for whom this coupon was created. - object: The `customEffect` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'customEffect', required: An effect discriminator of type `customEffect`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` CustomEffectProps, required: 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-custom-effects). Custom effects can be used as both rule effects and failure effects. The structure of a custom effect depends on your specifications but is always named `customEffect`. - `effectId` integer, required: The ID of the custom effect that was triggered. - `name` string, required: The type of the custom effect. - `cartItemPosition` number: The index of the item in the cart item list to which the custom effect is applied. - `cartItemSubPosition` number: For cart items with quantity > 1, the sub position indicates to which item unit the custom effect is applied. - `bundleIndex` integer: The position of the bundle in a list of item bundles created from the same bundle definition. - `bundleName` string: The name of the bundle definition. - `payload` object, required: The JSON payload of the custom effect. - object: The `deductLoyaltyPoints` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'deductLoyaltyPoints', required: An effect discriminator of type `deductLoyaltyPoints`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` DeductLoyaltyPointsEffectProps, required: 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, use the `cardIdentifier` property to identify the loyalty card from which these points are deducted. The Rule Engine deducts points in this order: - Points with the earliest expiry date are deducted first, regardless of when they were added. - Points with an unlimited expiry date are deducted last. - For points with an unlimited expiry date, the points awarded first are deducted first. The points only persist when the session is closed. - `ruleTitle` string, required: The title of the rule that contained triggered this points deduction. - `programId` integer, required: The ID of the loyalty program from which these points were deducted. - `subLedgerId` string, required: The ID of the subledger within the loyalty program from which these points were deducted. - `value` number, required: The amount of points that were deducted. - `transactionUUID` string, required: The identifier of this loyalty point transaction. - `name` string, required: The reason of this loyalty points deduction. - `cardIdentifier` string: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - object: The `error` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'error', required: An effect discriminator of type `error`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` ErrorEffectProps, required: This effect is triggered whenever an error occurs during rule evaluation. This effect only provides information about what the error is. - `message` string, required: The error message. - object: The `extendLoyaltyPointsExpiryDate` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'extendLoyaltyPointsExpiryDate', required: An effect discriminator of type `extendLoyaltyPointsExpiryDate`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` ExtendLoyaltyPointsExpiryDateEffectProps, required: If loyalty points have an expiry date, this effect extends the expiry of all active and pending point transactions by a selected duration. - `programId` integer, required: ID of the loyalty program that contains these points. - `subLedgerId` string, required: API name of the loyalty program subledger that contains these points. - `extensionDuration` string, required: Time frame by which the expiry date extends. The time format is either: - immediate, or - an **integer** followed by a letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. - `affectedTransactions` LoyaltyLedgerEntryExpiryDateChange[]: List of transactions affected by the expiry date update. - … - object: The `increaseAchievementProgress` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'increaseAchievementProgress', required: An effect discriminator of type `increaseAchievementProgress`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` IncreaseAchievementProgressEffectProps, required: 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 customer progress](https://docs.talon.one/docs/product/rules/effects/use-effects#update-customer-progress) effect is successfully validated. For [on-completion achievements](https://docs.talon.one/docs/product/achievements/overview#recurring-on-completion-achievements), any customer progress exceeding the target automatically starts a new iteration. This generates a new `progressTrackerId` for each iteration, and there can be multiple progress updates for the same achievement from a single validation of this effect. - `achievementId` integer, required: The internal ID of the achievement. - `achievementName` string, required: The name of the achievement. - `progressTrackerId` integer: The internal ID of the customer progress tracker. For [on-completion achievements](https://docs.talon.one/docs/product/achievements/overview#recurring-on-completion-achievements), this effect generates a unique ID for each iteration. - `delta` number, required: The value by which the customer's current progress in the achievement has increased. - `value` number, required: The current progress of the customer in the achievement. - `target` number, required: The target value to complete the achievement. - `isJustCompleted` boolean, required: Indicates if the customer has completed the achievement in the current session. - object: The `increaseAchievementProgressPerItem` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'increaseAchievementProgressPerItem', required: An effect discriminator of type `increaseAchievementProgressPerItem`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` IncreaseAchievementProgressPerItemEffectProps, required: This effect schema is returned when you use the **Update customer progress per item** effect in a rule. It indicates that the customer's progress in an achievement was updated during the current session for a specific cart item. If your list of cart items is a [bundle definition](https://docs.talon.one/docs/product/rules/create-and-manage-bundles), use the `bundleIndex` and `bundleName` properties to identify the bundle containing the item whose progress was updated. If the cart item has a quantity greater than one, use the `cartItemSubPosition` property to identify the specific unit within the item's line item. For [on-completion achievements](https://docs.talon.one/docs/product/achievements/overview#recurring-on-completion-achievements), any customer progress exceeding the target automatically starts a new iteration. This generates a new `progressTrackerId` for each iteration, and there can be multiple progress updates for the same achievement from a single validation of this effect. - `achievementId` integer, required: The internal ID of the achievement. - `achievementName` string, required: The name of the achievement. - `progressTrackerId` integer: The internal ID of the customer progress tracker. For [on-completion achievements](https://docs.talon.one/docs/product/achievements/overview#recurring-on-completion-achievements), this effect generates a unique ID for each iteration. - `delta` number, required: The value by which the customer's current progress in the achievement has increased. - `value` number, required: The current progress of the customer in the achievement. - `target` number, required: The target value to complete the achievement. - `isJustCompleted` boolean, required: Indicates if the customer has completed the achievement in the current session. - `cartItemPosition` number, required: The index of the item in the `cartItem` object on which the customer's progress in the achievement was updated. - `cartItemSubPosition` number: For cart items with `quantity` > 1, indicates which specific unit of the item the effect applies to. - `bundleIndex` integer: _(With bundles only)_ The position of the specific bundle in the list of bundles created from the same bundle definition. For example, if a customer creates two identical bundles, the first has index `0` and the second has index `1`. - `bundleName` string: _(With bundles only)_ The name of the bundle definition. - object: The `joinLoyaltyProgram` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'joinLoyaltyProgram', required: An effect discriminator of type `joinLoyaltyProgram`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` JoinLoyaltyProgramEffectProps, required: This effect indicates that a customer profile was joined to a profile-based loyalty program with the specified join date. > [!note] **Note** > - This effect requires a customer profile. It does not work for anonymous sessions. > - The effect fails if the customer profile has already joined the loyalty program. - `programId` integer, required: The ID of the loyalty program the customer profile is joined to. - `joinDate` string, date-time, required: The date and time when the customer profile joined the loyalty program. - object: The `offsetNegativeLoyaltyPoints` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'offsetNegativeLoyaltyPoints', required: An effect discriminator of type `offsetNegativeLoyaltyPoints`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - object: The `redeemReferral` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'redeemReferral', required: An effect discriminator of type `redeemReferral`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` RedeemReferralEffectProps, required: 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. - `id` integer, required: The id of the referral code that was redeemed. - `value` string, required: The referral code that was redeemed. - object: The `referralCreated` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'referralCreated', required: An effect discriminator of type `referralCreated`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` ReferralCreatedEffectProps, required: The `referralCreated` effect behaves similarly to [couponCreated](https://docs.talon.one/docs/dev/integration-api/api-effects#couponcreated). If the `friendProfileIntegrationId` parameter is empty, the referral code can be redeemed by anyone. - `value` string, required: The referral code provided in the session. - object: The `rejectCoupon` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'rejectCoupon', required: An effect discriminator of type `rejectCoupon`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` RejectCouponEffectProps, required: 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. - `value` string, required: The coupon code that was rejected. - `rejectionReason` string, required: The reason why the code was rejected. - `CampaignLimitReached`: The campaign-wide coupon code redemption limit has been reached. - `CouponExpired`: The coupon is expired. - `CouponLimitReached`: The coupon redemption limit or a campaign budget was reached. - `CouponNotFound`: The coupon code is incorrect. - `CouponPartOfNotRunningCampaign`: The campaign the coupon belongs to is currently not active. The campaignId field contains the ID of that campaign. - `CouponRecipientDoesNotMatch`: The given coupon value does not match the recipient or the coupon is linked to a `recipientIntegrationID` but there is no profile in the session. - `CouponRejectedByCondition`: Other conditions failed in the rule or all conditions passed but the `Coupon code is valid` condition is not present. - `CouponStartDateInFuture`: The coupon isn't active yet. - `EffectCouldNotBeApplied`: One of the effects in the campaign wasn't applied because a limit for that effect was reached (most common use case will be `setDiscount` cannot be applied because a discount limit is reached). - `ProfileLimitReached`: The profile-specific coupon redemption limit has been reached. - `CouponPartOfNotTriggeredCampaign`: The campaign the coupon belongs to was not triggered during evaluation (an exclusive or stackable campaign). The `campaignId` field contains the ID of that campaign. - `CouponReservationRequired`: The coupon's `isReservationMandatory` property is `true`, but the profile does not have a reservation. - `ProfileRequired`: The coupon's `isReservationMandatory` property is `true` or a [campaign profile budget](https://docs.talon.one/docs/product/campaigns/settings/manage-campaign-budgets) was set, but no profile exists in the session. - `conditionIndex` integer: The index of the condition that caused the rejection of the coupon. - `effectIndex` integer: The index of the effect that caused the rejection of the coupon. - `details` string: More details about the failure. - `campaignExclusionReason` string: The reason why the campaign the coupon belongs to was excluded during [campaign evaluation](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation), when `rejectionReason` was `CouponPartOfNotTriggeredCampaign`. Its possible values are: - `CampaignGaveLowerDiscount`: The required campaign and coupon conditions were met, but another campaign in a [Highest discount value](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group offered a higher discount value. - `CampaignIsNotFirst`: The campaign was not evaluated because another campaign in a [First campaign](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group was picked and evaluated first. - `CampaignNotInEvaluationSet`: The campaign did not meet other evaluation requirements, for example, because the coupon is part of an archived campaign. - object: The `rejectReferral` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'rejectReferral', required: An effect discriminator of type `rejectReferral`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` RejectReferralEffectProps, required: This effect indicates that the provided referral code is invalid. - `value` string, required: The referral code that was rejected - `rejectionReason` string, required: The reason why the code was rejected. - `AdvocateNotFound`: The advocate was not found. - `CampaignLimitReached`: The campaign-wide referral code redemption limit has been reached. - `EffectCouldNotBeApplied`: One of the effects in the campaign wasn't applied because a limit for that effect was reached (most common use case will be `setDiscount` can not be applied because a discount limit is reached). - `ProfileLimitReached`: The profile-specific referral code redemption limit has been reached. - `ReferralCustomerAlreadyReferred`: The friend is already referred. - `ReferralExpired`: The transferred referral code is expired. - `ReferralLimitReached`: The referral code redemption limit has been reached. - `ReferralNotFound`: The transferred referral code is wrong. - `ReferralPartOfNotRunningCampaign`: The campaign the referral code belongs to is currently not active. The campaign ID field shows the ID of that campaign. - `ReferralRecipientDoesNotMatch`: The given referral code value does not match the recipient. - `ReferralRecipientIdSameAsAdvocate`: The recipient (friend) has the same id as the advocate. - `ReferralRejectedByCondition`: The referral code is valid and in an active campaign, but there were other conditions in that campaign's rules that were not met. - `ReferralStartDateInFuture`: The transferred referral code isn't active yet. - `ReferralPartOfNotTriggeredCampaign`: The campaign the referral code belongs to was not triggered during evaluation (an exclusive or stackable campaign). The campaign ID field shows the ID of that campaign. - `conditionIndex` integer: The index of the condition that caused the rejection of the referral. - `effectIndex` integer: The index of the effect that caused the rejection of the referral. - `details` string: More details about the failure. - `campaignExclusionReason` string: The reason why the campaign the referral belongs to was excluded during [campaign evaluation](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation), when `rejectionReason` was `CouponPartOfNotTriggeredCampaign`. Its possible values are: - `CampaignGaveLowerDiscount`: The required campaign and referral conditions were met, but another campaign in a [Highest discount value](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group offered a higher discount value. - `CampaignIsNotFirst`: The campaign was not evaluated because another campaign in a [First campaign](https://docs.talon.one/docs/product/applications/manage-campaign-evaluation#set-campaign-evaluation-mode) group was picked and evaluated first. - `CampaignNotInEvaluationSet`: The campaign did not meet other evaluation requirements, for example, because the referral is part of an archived campaign. - object: The `removeFromAudience` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'removeFromAudience', required: An effect discriminator of type `removeFromAudience`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` RemoveFromAudienceEffectProps, required: This effect is triggered when a rule containing an [Update audience](https://docs.talon.one/docs/product/rules/effects/use-effects#update-an-audience) effect with **Remove customer from an audience** selected is validated. It indicates that a customer was removed from an audience and is returned when a customer session is opened, updated, or closed. - `audienceId` integer: The internal ID of the audience. - `audienceName` string: The name of the audience. - `profileIntegrationId` string: The ID of the customer profile in the third-party integration platform. - `profileId` integer: The internal ID of the customer profile. - object: The `reserveCoupon` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'reserveCoupon', required: An effect discriminator of type `reserveCoupon`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` ReserveCouponEffectProps, required: 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 [Reserve a coupon code](https://docs.talon.one/docs/product/rules/effects/use-effects#reserve-a-coupon-code). - `couponValue` string, required: The coupon code that was created. - `profileIntegrationId` string, required: The integration identifier of the customer for whom this coupon was reserved. - `isNewReservation` boolean, required: Indicates whether this is a new coupon reservation or not. - object: The `rollbackAddedLoyaltyPoints` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'rollbackAddedLoyaltyPoints', required: An effect discriminator of type `rollbackAddedLoyaltyPoints`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` RollbackAddedLoyaltyPointsEffectProps, required: 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 loyalty point were added by the returned items. See [returning items](https://docs.talon.one/docs/dev/tutorials/partially-return-a-session). If you use the [Add loyalty points per item effect](https://docs.talon.one/docs/product/rules/effects/available-effects#reward-effects), use the `cartItemPosition` property to identify which items the loyalty points were rolled back for. If you use **Add loyalty points per item** and if the session contains some cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the item unit in its line item. If the loyalty program is [profile-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `recipientIntegrationId` property to identify the user for whom the loyalty points are rolled back. If the loyalty program is [card-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `cardIdentifier` property to identify the loyalty card where the points were originally added. - `programId` integer, required: The ID of the loyalty program where these points were rolled back. - `subLedgerId` string, required: The ID of the subledger within the loyalty program where these points were rolled back. - `value` number, required: The amount of points that were rolled back. - `recipientIntegrationId` string, required: The user for whom these points were rolled back. - `transactionUUID` string, required: The identifier of this loyalty point transaction. - `cartItemPosition` number: (_Add points per cart item_ only.) The index of the item in the `cartItem` object for which these points were rolled back. - `cartItemSubPosition` number: (_Add points per cart item_ ) The index of the item unit in its line item. - `cardIdentifier` string: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - object: The `rollbackCoupon` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'rollbackCoupon', required: An effect discriminator of type `rollbackCoupon`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` RollbackCouponEffectProps, required: This effect indicates that a coupon code redemption has been rolled back. The coupon becomes redeemable again. This effect is triggered in the following cases: - A session where a coupon was accepted is [cancelled](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#manage-the-sessions-state). See an example of use in the [cancelling a session tutorial](https://docs.talon.one/docs/dev/tutorials/roll-back-effects). - A session where a coupon was accepted is [reopened](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession). - `value` string, required: The coupon code whose redemption has been rolled back. - object: The `rollbackDeductedLoyaltyPoints` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'rollbackDeductedLoyaltyPoints', required: An effect discriminator of type `rollbackDeductedLoyaltyPoints`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` RollbackDeductedLoyaltyPointsEffectProps, required: This effect is triggered in the following cases: - A session is _cancelled_ and this session deducted loyalty points. The rollback action returns the redeemed loyalty points to the customer. - A session is impacted by a _partial return_. Only added loyalty points that are still **pending** are rolled back. - A session in which loyalty points were spent is reopened. See the [session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). If you set custom activation and expiration dates for the loyalty points, use the `startDate` and `expiryDate` properties to identify when the reward will be active and when will expire. If the loyalty program is [profile-based](https://docs.talon.one/docs/product/loyalty-programs/profile-based/profile-based-overview), use the `recipientIntegrationId` property to identify the user who receives the loyalty points. If the loyalty program is [card-based](https://docs.talon.one/docs/product/loyalty-programs/overview#loyalty-program-types), use the `cardIdentifier` property to identify the loyalty card where the points are reimbursed. - `programId` integer, required: The ID of the loyalty program where these points were reimbursed. - `subLedgerId` string, required: The ID of the subledger within the loyalty program where these points were reimbursed. - `value` number, required: The amount of points that were reimbursed. - `recipientIntegrationId` string, required: The user for whom these points were reimbursed. - `startDate` string, date-time: The date after which the reimbursed points will be valid. - `expiryDate` string, date-time: The date after which the reimbursed points will expire. - `transactionUUID` string, required: The identifier of this loyalty point transaction. - `cardIdentifier` string: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - object: The `rollbackDiscount` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'rollbackDiscount', required: An effect discriminator of type `rollbackDiscount`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` RollbackDiscountEffectProps, required: 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 set the status of a session to `cancel` or the status changes to `partially_returned`. If the session contains some cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the specific item unit in its line item. See the example below. - `name` string, required: The name of the discount effect that was rolled back. - `value` number, required: The monetary value of the discount that was rolled back. - `cartItemPosition` number: The index of the item in the `cartItem` object whose discount was rolled back, or the unit containing the additional cost whose discount was rolled back. - `cartItemSubPosition` number: The index of the item unit in its line item for which the discount was rolled back. - `additionalCostId` integer: _Only when rolling back [setDiscountPerAdditionalCost](https://docs.talon.one/docs/dev/integration-api/api-effects#setdiscountperadditionalcost) and [setDiscountPerAdditionalCostPerItem](https://docs.talon.one/docs/dev/integration-api/api-effects#setdiscountperadditionalcostperitem)_ The ID of the additional cost to be discounted. - `additionalCost` string: The API name of the additional cost whose discount was rolled back. - `scope` string: The scope of the rolled back discount. - For a discount per session, it can be one of `cartItems`, `additionalCosts` or `sessionTotal` - For a discount per item, it can be one of `price`, `additionalCosts` or `itemTotal` - object: The `rollbackIncreasedAchievementProgress` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'rollbackIncreasedAchievementProgress', required: An effect discriminator of type `rollbackIncreasedAchievementProgress`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` RollbackIncreasedAchievementProgressEffectProps, required: 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 customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession) that previously validated the [Update customer progress](https://docs.talon.one/docs/product/rules/effects/use-effects#update-customer-progress) effect and triggered the [increaseAchievementProgress](https://docs.talon.one/docs/dev/integration-api/api-effects#increaseachievementprogress) API effect. The effect is also triggered for completed achievements if the **Allow progress rollback for completed achievements** setting is enabled. You can enable this through the [Campaign Manager](https://docs.talon.one/docs/product/achievements/manage-achievements) or the [Management API](https://docs.talon.one/management-api#tag/Achievements/operation/createAchievement) by setting the `achievementAllowRollbackAfterCompletion` property to `true`. This setting only applies to one-time and recurring on expiration achievements. - `achievementId` integer, required: The internal ID of the achievement. - `achievementName` string, required: The name of the achievement. - `progressTrackerId` integer, required: The internal ID of the achievement progress tracker. - `decreaseProgressBy` number, required: The value by which the customer's current progress in the achievement has decreased. - `currentProgress` number, required: The current progress of the customer in the achievement. - `target` number, required: The target value to complete the achievement. - object: The `rollbackIncreasedAchievementProgressPerItem` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'rollbackIncreasedAchievementProgressPerItem', required: An effect discriminator of type `rollbackIncreasedAchievementProgressPerItem`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` RollbackIncreasedAchievementProgressPerItemEffectProps, required: This effect schema is returned when you cancel or [reopen a customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession) that previously validated the **Update customer progress per item** effect. It indicates that the customer's progress in an achievement was rolled back for a specific cart item. If your list of cart items is a [bundle definition](https://docs.talon.one/docs/product/rules/create-and-manage-bundles), use the `bundleIndex` and `bundleName` properties to identify the bundle containing the item whose progress was rolled back. If the session contains cart items with _quantity > 1_, use the `cartItemSubPosition` property to identify the specific unit within the item's line item. The effect is also triggered for completed achievements if the **Allow progress rollback for completed achievements** setting is enabled. You can enable this through the [Campaign Manager](https://docs.talon.one/docs/product/achievements/manage-achievements) or the [Management API](https://docs.talon.one/management-api#tag/Achievements/operation/createAchievement) by setting the `achievementAllowRollbackAfterCompletion` property to `true`. This setting only applies to one-time and recurring on expiration achievements. - `achievementId` integer, required: The internal ID of the achievement. - `achievementName` string, required: The name of the achievement. - `progressTrackerId` integer, required: The internal ID of the achievement progress tracker. - `decreaseProgressBy` number, required: The value by which the customer's current progress in the achievement has decreased. - `currentProgress` number, required: The current progress of the customer in the achievement. - `target` number, required: The target value to complete the achievement. - `cartItemPosition` number, required: The index of the item in the `cartItem` object on which the customer's progress in the achievement was updated. - `cartItemSubPosition` number: For cart items with `quantity` > 1, indicates which specific unit of the item the effect applies to. - `bundleIndex` integer: _(With bundles only)_ The position of the specific bundle in the list of bundles created from the same bundle definition. For example, if a customer creates two identical bundles, the first has index `0` and the second has index `1`. - `bundleName` string: _(With bundles only)_ The name of the bundle definition. - object: The `rollbackReferral` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'rollbackReferral', required: An effect discriminator of type `rollbackReferral`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` RollbackReferralEffectProps, required: 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 cancelled. The code becomes redeemable again. For more information about session states, see [Managing states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states). - `value` string, required: The referral code to be rolled back. - object: The `rollbackTierBoost` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'rollbackTierBoost', required: An effect of type `rollbackTierBoost`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` RollbackTierBoostEffectProps, required: This effect indicates that a loyalty tier boost was rolled back. The Rule Engine triggers this effect when you cancel a customer session that previously triggered the [boostLoyaltyTier](https://docs.talon.one/docs/dev/integration-api/api-effects#boostloyaltytier) API effect. The tier boost is voided and the customer returns to the tier determined by their points balance. This effect only applies to full session cancellations. Partially returned sessions do not trigger a tier boost rollback. - `programId` integer, required: The ID of the loyalty program. - `subLedgerId` string, required: The ID of the subledger within the loyalty program. - `tierName` string, required: The name of the boosted tier that was rolled back. - `boostUuid` string, uuid, required: The unique identifier of the tier boost that was rolled back. Matches the `boostUuid` of the original `boostLoyaltyTier` effect. - object: The `rollbackUseReward` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'rollbackUseReward', required: An effect discriminator of type `rollbackUseReward`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` RollbackUseRewardEffectProps, required: This effect is triggered when a reward usage has been rolled back by a session cancellation. - `integrationId` string, required: The integration ID of the customer reward that was rolled back. - `rewardId` integer, required: The ID of the reward that was rolled back. - `applicationId` integer, required: The ID of the Application the reward belongs to. - object: The `set` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'set', required: An effect discriminator of type `set`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` UpdateAttributeEffectProps, required: This effect indicates that a rule containing an [Update attribute value](https://docs.talon.one/docs/product/rules/effects/available-effects#update-effects) or [Update cart item attribute value](https://docs.talon.one/docs/product/rules/effects/available-effects#update-effects) was validated. You should update the value of the attribute in your system based on the content of the returned effect. - `path` string, required: The entity type and the attribute name. - `value` unknown, required - object: The `setDiscount` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'setDiscount', required: An effect discriminator of type `setDiscount`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` SetDiscountEffectProps, required: 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 overwrite any existing discount with the same name. The most recent integration state update always returns the latest values for **all** effects, effectively overwriting any previous effects. Enabling [partial discounts](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-discounts) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches `0`. Use the `desiredValue` property to identify the original value of the discount. - `name` string, required: The name or description of this discount. - `value` number, required: The monetary value of the effective discount. - `scope` string: What the discount applies to. Possible values: - `cartItems`: Discount on the price of the items. - `additionalCosts`: Discount on the [additional costs](https://docs.talon.one/docs/product/account/dev-tools/manage-additional-costs) of the items. - `sessionTotal`: Discount on the total value of the customer session. **Note:** [Cascading discounts](https://docs.talon.one/docs/product/applications/manage-general-settings#cascading-discounts) must be enabled for this property to be returned. - `desiredValue` number: _(Partial discounts enabled only)_ The monetary value of the discount to be applied without considering budget limitations. - object: The `setDiscountPerAdditionalCost` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'setDiscountPerAdditionalCost', required: An effect discriminator of type `setDiscountPerAdditionalCost`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` SetDiscountPerAdditionalCostEffectProps, required: 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 cost** effect is validated. Enabling [partial rewards](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-rewards) allows a rule that would fail because of insufficient budget to pass. The rule still fails when the budget reaches 0. Use the `desiredValue` property to identify the original amount of loyalty points. - `name` string, required: The name of the discount. - `additionalCostId` integer, required: The identifier of the additional cost. - `additionalCost` string, required: The API name of the additional cost. - `value` number, required: The monetary value of the discount to apply. - `desiredValue` number: _(Partial discounts enabled only)_ The monetary value of the discount to be applied without considering budget limitations. - object: The `setDiscountPerAdditionalCostPerItem` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'setDiscountPerAdditionalCostPerItem', required: An effect discriminator of type `setDiscountPerAdditionalCostPerItem`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` SetDiscountPerAdditionalCostPerItemEffectProps, required: 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 **Discount additional cost per item** effect is validated. Use this effect when **all** items in the cart have an additional cost. If one of more items do not have an additional cost, the rule will fail. - `name` string, required: The description of this discount. `#number` is appended to the name. It is equal to the `position` property. - `additionalCostId` integer, required: The identifier of the additional cost to be discounted. - `value` number, required: The monetary value of the effective discount applied to the item's additional cost. - `position` number, required: The index of the item in the `cartItem` object containing the additional cost that this discount applies to. - `subPosition` number: The index of the item unit in its line item. - `additionalCost` string, required: The API name of the additional cost to be discounted. - `desiredValue` number: _[(Partial discounts enabled only)](https://docs.talon.one/docs/product/applications/manage-general-settings#partial-discounts)_. The monetary value of the discount to be applied to the additional cost without considering budget limitations. - object: The `setDiscountPerItem` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'setDiscountPerItem', required: An effect discriminator of type `setDiscountPerItem`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` SetDiscountPerItemEffectProps, required: 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 a rule. It indicates that a discount per item should be applied on the specific item specified in the effect. The properties it contains depends on: - Whether you used a pro rata effect or not. - Whether you used an effect with bundles or not. - Whether the partial discount feature is enabled. - `name` string, required: The description of this discount. `#number` is equal to the `position` property. - `value` number, required: The monetary value of the effective discount applied to the item. - `position` number, required: The index of the item in the `cartItem` object on which this discount should be applied. - `subPosition` number: The index of the item unit in its line item. - `desiredValue` number: _(Partial discounts enabled only)_ The monetary value of the discount to be applied to the item without considering budget limitations. - `scope` string: What the discount applies to. Possible values: - `price`: discount on the price of the item. - `additionalCosts`: discount on the [additional cost](https://docs.talon.one/docs/product/account/dev-tools/manage-additional-costs) of the item. - `itemTotal`: discount on the sum of price + additional cost of the item. - `totalDiscount` number: _(Pro rata discounts only)_ The monetary value of the total effective discount - `desiredTotalDiscount` number: _(Pro rata discounts only)_ The monetary value of the total discount to be applied without considering budget limitations - `bundleIndex` integer: _(Discounts with bundles only)_ The position of the specific item bundle in the list of bundles created from the same bundle definition. - `bundleName` string: _(Discounts with bundles only)_ The name of the bundle definition. - `targetedItemPosition` number: _(Discounting individual item in bundles only)_ The index of the targeted bundle item on which the applied discount is based. - `targetedItemSubPosition` number: _(Discounting individual item in bundles only)_ The sub-position of the targeted bundle item on which the applied discount is based. - `excludedFromPriceHistory` boolean: When set to `true`, the applied discount is excluded from the item's price history. - object: The `setLoyaltyPointsExpiryDate` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'setLoyaltyPointsExpiryDate', required: An effect discriminator of type `setLoyaltyPointsExpiryDate`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` SetLoyaltyPointsExpiryDateEffectProps, required: This effect updates the expiry date of all active, pending, and unlimited point transactions to a specific date. - `programId` integer, required: ID of the loyalty program that contains these points. - `subLedgerId` string, required: API name of the loyalty program subledger that contains these points. - `newExpiryDate` string, date-time, required: The specified expiry date and time for all active and pending point transactions in the loyalty program subledger. - `affectedTransactions` LoyaltyLedgerEntryExpiryDateChange[]: List of transactions affected by the expiry date update. - … - object: The `showBundleMetadata` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'showBundleMetadata', required: An effect discriminator of type `showBundleMetadata`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` ShowBundleMetadataEffectProps, required: This effect is **deprecated**. The `ShowBundleMetadata` effect contains information that allows you to associate the discounts from a rule in a bundle campaign with specific cart items. This way you can distinguish from "normal" discounts that were not the result of a product bundle. - `description` string, required: Description of the product bundle. - `bundleAttributes` string[], required: The cart item attributes that determined which items are being bundled together. - `itemsIndices` number[], required: The indices in the cart items array of the bundled items. - object: The `showNotification` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'showNotification', required: An effect discriminator of type `showNotification`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` ShowNotificationEffectProps, required: 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 to use the Rule Builder to decide why and when to show notifications. Notifications can be used as both rule effects and failure effects. A common use case is to display the notification at the top of the cart view in your web app. You can use the notification type to vary the styling of the notification message. - `notificationType` string, required: The type of notification. - `title` string, required: The title of the notification. - `body` string, required: The body of the notification. - object: The `startAchievementProgress` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'startAchievementProgress', required: An effect discriminator of type `startAchievementProgress`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` StartAchievementProgressEffectProps, required: This effect indicates that the customer's progress in an achievement was started during the current session. The Rule Engine creates a progress tracker for the customer, identified by `progressTrackerId`. This effect only starts the customer's progress and does not increase the progress. When this effect is returned, the customer progress status is `inprogress` and the progress value is `0`. You can retrieve the customer's current progress at any time, whether or not this effect was returned, in the following ways: - Include `achievements` in the `responseContent` property of your request, on any endpoint where this property is available, for example [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2). - Use the [List customer's available achievements](https://docs.talon.one/integration-api#tag/Achievements/operation/getCustomerAchievements) endpoint. - Use the [List customer's achievement history](https://docs.talon.one/integration-api#tag/Achievements/operation/getCustomerAchievementHistory) endpoint. For recurring achievements, this effect is only returned for the first iteration and has no effect on the iterations that follow. For [recurring user-action achievements](https://docs.talon.one/docs/product/achievements/overview#recurring-user-action-achievements) specifically, this effect also begins the customer's progress period, specified by the `startDate` and `endDate` properties. This effect is triggered in the following cases: - A rule containing a [Start customer progress](https://docs.talon.one/docs/product/rules/effects/use-effects#start-customer-progress) effect is validated. - A rule containing an [Update customer progress](https://docs.talon.one/docs/product/rules/effects/use-effects#update-customer-progress) effect is validated for an achievement that the customer has not started yet. In this case, the Rule Engine returns the `startAchievementProgress` effect first, followed by [increaseAchievementProgress](https://docs.talon.one/docs/dev/integration-api/api-effects#increaseachievementprogress), which carries the increased customer progress. Use `progressTrackerId` to connect the results produced by the two effects. **Note:** - This effect is not returned if the customer's progress in the achievement has already started, or if the achievement's end date has passed. In these cases, the **Start customer progress** effect fails, an [error](https://docs.talon.one/docs/dev/integration-api/api-effects#error) effect is returned, and the customer's progress remains unchanged. Any other effects in the same rule are also not applied. - If a rule with this effect fails, include `ruleFailureReasons` in the `responseContent` property of your request to see the reason for failure. The customer's progress is unchanged, so no update is required. The failure reason identifies the campaign, ruleset, and rule that failed, and `details` explains why. - There is no rollback effect for the `startAchievementProgress` effect. - `achievementId` integer, required: The ID of the achievement. - `achievementName` string, required: The name of the achievement. - `progressTrackerId` integer: The ID of the customer's progress tracker for this achievement. For [on-completion achievements](https://docs.talon.one/docs/product/achievements/overview#recurring-on-completion-achievements), this effect generates a unique ID for each iteration. - `target` number, required: The target value to complete the achievement. - `startDate` string, date-time, required: Timestamp at which the customer's progress started. - `endDate` string, date-time: Timestamp at which this progress period ends. Only returned for achievements that have a fixed end date. [On-completion achievements](https://docs.talon.one/docs/product/achievements/overview#recurring-on-completion-achievements) have no end date. - object: The `unlockReward` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'unlockReward', required: An effect discriminator of type `unlockReward`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` UnlockRewardEffectProps, required: The properties specific to the "unlockReward" effect. This gets triggered whenever a validated rule unlocks a reward for a customer profile. - `integrationId` string, required: The integration ID assigned to the customer reward unlock. - `rewardId` integer, required: The internal ID of the reward that was unlocked. - `applicationId` integer, required: The internal ID of the application the reward belongs to. - `profileIntegrationId` string, required: The integration ID of the customer profile that unlocked the reward. - `unlockedAt` string, date-time, required: The time the reward was unlocked. - `loyaltyCardId` string: The identifier of the loyalty card, which must match the regular expression `^[A-Za-z0-9._%+@-]+$`. - object: The `useReward` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'useReward', required: An effect discriminator of type `useReward`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` UseRewardEffectProps, required: This effect is triggered when a rule that uses a customer's unlocked reward is validated during session evaluation. - `integrationId` string, required: The integration ID of the customer reward that was used. - `rewardId` integer, required: The ID of the reward that was used. - `applicationId` integer, required: The ID of the Application the reward belongs to. - object: The `willAwardGiveaway` effect and its properties. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects). - `experimentId` integer: The ID of the experiment that campaign belongs to. - `campaignId` integer, required: The ID of the campaign that triggered this effect. - `rulesetId` integer, required: The ID of the ruleset that was active in the campaign when this effect was triggered. - `ruleIndex` integer, required: The position of the rule that triggered this effect within the ruleset. - `ruleName` string, required: The name of the rule that triggered this effect. - `effectType` 'willAwardGiveaway', required: An effect discriminator of type `willAwardGiveaway`. - `triggeredByCoupon` integer: The ID of the coupon that was being evaluated when this effect was triggered. - `triggeredForCatalogItem` integer: The ID of the catalog item that was being evaluated when this effect was triggered. - `conditionIndex` integer: The index of the condition that was triggered. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `campaignRevisionId` integer: The revision ID of the campaign that was used when triggering the effect. - `campaignRevisionVersionId` integer: The revision version ID of the campaign that was used when triggering the effect. - `selectedPriceType` string: The selected price type for the SKU targeted by this effect. - `selectedPrice` number: The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied. - `adjustmentReferenceId` string, uuid: The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment. - `rewardId` integer: The ID of the reward that was being evaluated when this effect was triggered. - `rewardIntegrationId` string: The integration ID of the specific customer reward whose usage produced this effect. - `props` WillAwardGiveawayEffectProps, required: 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 when they are still not guaranteed to be awarded. For more information about session states, see [Manage the session's state](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#manage-the-sessions-state). - `poolId` integer, required: The internal ID of the giveaway pool. - `poolName` string, required: The name of the giveaway pool. - `recipientIntegrationId` string, required: The integration ID of the customer that receives the giveaway. - `ruleFailureReasons` RuleFailureReason[]: An array containing the rule failure reasons which happened during this event. - `campaignID` integer, required: The ID of the campaign that contains the rule that failed. - `campaignName` string, required: The name of the campaign that contains the rule that failed. - `rulesetID` integer, required: The ID of the ruleset that contains the rule that failed. - `couponID` integer: The ID of the coupon that was being evaluated at the time of the rule failure. - `couponValue` string: The code of the coupon that was being evaluated at the time of the rule failure. - `referralID` integer: The ID of the referral that was being evaluated at the time of the rule failure. - `referralValue` string: The code of the referral that was being evaluated at the time of the rule failure. - `rewardId` integer: The ID of the reward that was being evaluated at the time of the rule failure. - `rewardIntegrationId` string: The integration ID of the reward that was being evaluated at the time of the rule failure. - `ruleIndex` integer, required: The index of the rule that failed within the ruleset. - `ruleName` string, required: The name of the rule that failed within the ruleset. - `conditionIndex` integer: The index of the condition that failed. - `effectIndex` integer: The index of the effect that failed. - `details` string: More details about the failure. - `evaluationGroupID` integer: The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). - `evaluationGroupMode` string: The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation). ## Changes - **2026-11-07** `7ef1b9504c3a`: 2 breaking, 4 info - added `#/components/schemas/EffectAcceptCoupon, #/components/schemas/EffectAcceptReferral, #/components/schemas/EffectAddFreeItem, #/components/schemas/EffectAddLoyaltyPoints, #/components/schemas/EffectAddNegativeLoyaltyPoints, #/components/schemas/EffectAddToAudience, #/components/schemas/EffectAwardGiveaway, #/components/schemas/EffectBoostLoyaltyTier, #/components/schemas/EffectCallApi, #/components/schemas/EffectChangeLoyaltyTierLevel, #/components/schemas/EffectCouponCreated, #/components/schemas/EffectCustomEffect, #/components/schemas/EffectDeductLoyaltyPoints, #/components/schemas/EffectError, #/components/schemas/EffectExtendLoyaltyPointsExpiryDate, #/components/schemas/EffectIncreaseAchievementProgress, #/components/schemas/EffectIncreaseAchievementProgressPerItem, #/components/schemas/EffectJoinLoyaltyProgram, #/components/schemas/EffectOffsetNegativeLoyaltyPoints, #/components/schemas/EffectRedeemReferral, #/components/schemas/EffectReferralCreated, #/components/schemas/EffectRejectCoupon, #/components/schemas/EffectRejectReferral, #/components/schemas/EffectRemoveFromAudience, #/components/schemas/EffectReserveCoupon, #/components/schemas/EffectRollbackAddedLoyaltyPoints, #/components/schemas/EffectRollbackCoupon, #/components/schemas/EffectRollbackDeductedLoyaltyPoints, #/components/schemas/EffectRollbackDiscount, #/components/schemas/EffectRollbackIncreasedAchievementProgress, #/components/schemas/EffectRollbackIncreasedAchievementProgressPerItem, #/components/schemas/EffectRollbackReferral, #/components/schemas/EffectRollbackTierBoost, #/components/schemas/EffectRollbackUseReward, #/components/schemas/EffectSet, #/components/schemas/EffectSetDiscount, #/components/schemas/EffectSetDiscountPerAdditionalCost, #/components/schemas/EffectSetDiscountPerAdditionalCostPerItem, #/components/schemas/EffectSetDiscountPerItem, #/components/schemas/EffectSetLoyaltyPointsExpiryDate, #/components/schemas/EffectShowBundleMetadata, #/components/schemas/EffectShowNotification, #/components/schemas/EffectStartAchievementProgress, #/components/schemas/EffectUnlockReward, #/components/schemas/EffectUseReward, #/components/schemas/EffectWillAwardGiveaway` to the `data/items/allOf[subschema #7]/effects/items/` response property `oneOf` list for the response status `200` - the `data/items/allOf[subschema #7]/effects/items/` response's property type changed from no type to `object` for status `200` - added the optional property `data/items/allOf[subschema #7]/ruleFailureReasons/items/rewardId` to the response with the `200` status - added the optional property `data/items/allOf[subschema #7]/ruleFailureReasons/items/rewardIntegrationId` to the response with the `200` status - …2 more [Operation history](https://skmtc.dev/talon/apis/management-api/changes/v1/applications/:applicationId/events/no_total/get.md) --- [API](https://skmtc.dev/talon/apis/management-api.md) - [All operations](https://skmtc.dev/talon/apis/management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/talon/apis/management-api/revisions/7ef1b9504c3a?raw)