Return Cart Items

Return cart items

POST/v2/customer_sessions/{customerSessionId}/returns

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Return Cart Items action (under integration).
Fill in the fields below, then reference the result from later steps as {{returnCartItems.response.data}}.

Request

Path parameters

customerSessionIdstringrequired

The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's **Sessions** menu, or via the [List Application session](https://docs.talon.one/management-api#tag/Customer-data/operation/getApplicationSessions) endpoint.

Query parameters

dryboolean

Indicates whether to persist the changes. Changes are ignored when `dry=true`.

runRuleEngineboolean

When set to `true`, reevaluates the updated session after items are returned. Only reevaluates campaigns where `reevaluateOnReturn` is set to `true` and which produced an effect when the session was closed.

Request body

Enter the body as JSON in the step's Body field.

returnobjectrequired

returnedCartItemsarray<object>required3 fields

List of cart items to be returned.

responseContentarray<string>

Extends the response with the chosen data entities. Use this property to get as much data as you need in one _Update customer session_ request instead of sending extra requests to other endpoints.

json

{
  "return": {
    "returnedCartItems": [
      {
        "quantity": 1,
        "position": 2,
        "sku": "SKU1241028"
      },
      {
        "quantity": 1,
        "position": 2,
        "sku": "SKU1241028"
      }
    ]
  },
  "responseContent": [
    "customerSession",
    "customerProfile"
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{returnCartItems.response.data.<field>}}.

customerProfileobject

idinteger (int64)required

The internal ID of the customer profile.

createdstring (date-time)required

The time this entity was created.

integrationIdstring (string)required

The integration ID set by your integration layer.

attributesobjectrequired

Arbitrary properties associated with this item.

accountIdinteger (int64)required

The ID of the Talon.One account that owns this profile.

closedSessionsinteger (int64)required

The total number of closed sessions. Does not include closed sessions that have been cancelled or reopened. See the [docs](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions#customer-session-states).

totalSalesnumberrequired

The total amount of money spent by the customer **before** discounts are applied. The total sales amount excludes the following: - Cancelled or reopened sessions. - Returned items.

loyaltyMembershipsarray<object>2 fields

**DEPRECATED. Always returns `null`.** A list of loyalty programs joined by the customer.

audienceMembershipsarray<object>2 fields

The audiences the customer belongs to.

lastActivitystring (date-time)required

Timestamp of the most recent event received from this customer. This field is updated on calls that trigger the Rule Engine and that are not [dry requests](https://docs.talon.one/docs/dev/integration-api/dry-requests/#overlay). For example, [reserving a coupon](https://docs.talon.one/integration-api#tag/Coupons/operation/createCouponReservation) for a customer doesn't impact this field.

sandboxboolean

An indicator of whether the customer is part of a sandbox or live Application. See the [docs](https://docs.talon.one/docs/product/applications/overview#application-environments).

loyaltyobject

Customer-specific information about loyalty points.

cardsarray<object>16 fields

Displays information about the balances of the loyalty cards.

programsobjectrequired

Displays information about point balances in profile-based programs.

triggeredCampaignsarray<object>

The campaigns that were triggered as a result of processing the event.

idinteger (int64)required

Unique ID for this entity.

createdstring (date-time)required

The exact moment this entity was created.

applicationIdinteger (int64)required

The ID of the Application that owns this entity.

userIdinteger (int64)required

The ID of the user associated with this entity.

namestringrequired

A user-facing name for this campaign.

descriptionstringrequired

A detailed description of the campaign.

startTimestring (date-time)

Timestamp when the campaign will become active.

endTimestring (date-time)

Timestamp when the campaign will become inactive.

attributesobject

Arbitrary properties associated with this campaign.

statestringrequired

A disabled or archived campaign is not evaluated for rules or coupons.

One ofenableddisabledarchivedDefault "enabled"

activeRulesetIdinteger (int64)

[ID of Ruleset](https://docs.talon.one/management-api#tag/Campaigns/operation/getRulesets) this campaign applies on customer session evaluation.

tagsarray<string>required

A list of tags for the campaign.

reevaluateOnReturnbooleanrequired

Indicates whether this campaign should be reevaluated when a customer returns an item.

featuresarray<string>required

The features enabled in this campaign.

couponSettingsobject2 fields

referralSettingsobject2 fields

limitsarray<object>required4 fields

The set of [budget limits](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets) for this campaign.

campaignGroupsarray<integer (int64)>

The IDs of the [campaign groups](https://docs.talon.one/docs/product/account/managing-campaign-groups) this campaign belongs to.

typestringrequired

The campaign type. Possible type values: - `cartItem`: Type of campaign that can apply effects only to cart items. - `advanced`: Type of campaign that can apply effects to customer sessions and cart items.

One ofcartItemadvancedDefault "advanced"

linkedStoreIdsarray<integer (int64)>

A list of store IDs that you want to link to the campaign. **Note:** Campaigns with linked store IDs will only be evaluated when there is a [customer session update](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2) that references a linked store.

couponAttributesobject

Arbitrary properties associated with coupons in this campaign.

budgetsarray<object>3 fields

A list of all the budgets that are defined by this campaign and their usage. **Note:** Budgets that are not defined do not appear in this list and their usage is not counted until they are defined.

couponRedemptionCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Number of coupons redeemed in the campaign.

referralRedemptionCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Number of referral codes redeemed in the campaign.

discountCountnumber

This property is **deprecated**. The count should be available under *budgets* property. Total amount of discounts redeemed in the campaign.

discountEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of times discounts were redeemed in this campaign.

couponCreationCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of coupons created by rules in this campaign.

customEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of custom effects triggered by rules in this campaign.

referralCreationCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of referrals created by rules in this campaign.

addFreeItemEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of times the [add free item effect](https://docs.talon.one/docs/dev/integration-api/api-effects#addfreeitem) can be triggered in this campaign.

awardedGiveawaysCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of giveaways awarded by rules in this campaign.

createdLoyaltyPointsCountnumber

This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points created by rules in this campaign.

createdLoyaltyPointsEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point creation effects triggered by rules in this campaign.

redeemedLoyaltyPointsCountnumber

This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty points redeemed by rules in this campaign.

redeemedLoyaltyPointsEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of loyalty point redemption effects triggered by rules in this campaign.

callApiEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of webhooks triggered by rules in this campaign.

reservecouponEffectCountinteger (int64)

This property is **deprecated**. The count should be available under *budgets* property. Total number of reserve coupon effects triggered by rules in this campaign.

lastActivitystring (date-time)

Timestamp of the most recent event received by this campaign.

updatedstring (date-time)

Timestamp of the most recent update to the campaign's property. Updates to external entities used in this campaign are **not** registered by this property, such as collection or coupon updates.

createdBystring

Name of the user who created this campaign if available.

effectsarray<object>

The effects generated by the rules in your running campaigns. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects).

experimentIdinteger (int64)

The ID of the experiment that campaign belongs to.

campaignIdinteger (int64)required

The ID of the campaign that triggered this effect.

rulesetIdinteger (int64)required

The ID of the ruleset that was active in the campaign when this effect was triggered.

ruleIndexinteger (int64)required

The position of the rule that triggered this effect within the ruleset.

ruleNamestringrequired

The name of the rule that triggered this effect.

effectTypestringrequired

The type of effect that was triggered. See [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects).

triggeredByCouponinteger (int64)

The ID of the coupon that was being evaluated when this effect was triggered.

triggeredForCatalogIteminteger (int64)

The ID of the catalog item that was being evaluated when this effect was triggered.

conditionIndexinteger (int64)

The index of the condition that was triggered.

evaluationGroupIDinteger (int64)

The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation).

evaluationGroupModestring

The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation).

campaignRevisionIdinteger (int64)

The revision ID of the campaign that was used when triggering the effect.

campaignRevisionVersionIdinteger (int64)

The revision version ID of the campaign that was used when triggering the effect.

selectedPriceTypestring

The selected price type for the SKU targeted by this effect.

selectedPricenumber

The value of the selected price type to apply to the SKU targeted by this effect, before any discounts are applied.

adjustmentReferenceIdstring (uuid)

The reference identifier of the selected price adjustment for this SKU. This is only returned if the `selectedPrice` resulted from a price adjustment.

propsobjectrequired

ruleFailureReasonsarray<object>

The reasons why certain rules were not triggered during the event processing.

campaignIDinteger (int64)required

The ID of the campaign that contains the rule that failed.

campaignNamestringrequired

The name of the campaign that contains the rule that failed.

rulesetIDinteger (int64)required

The ID of the ruleset that contains the rule that failed.

couponIDinteger (int64)

The ID of the coupon that was being evaluated at the time of the rule failure.

couponValuestring

The code of the coupon that was being evaluated at the time of the rule failure.

referralIDinteger (int64)

The ID of the referral that was being evaluated at the time of the rule failure.

referralValuestring

The code of the referral that was being evaluated at the time of the rule failure.

ruleIndexinteger (int64)required

The index of the rule that failed within the ruleset.

ruleNamestringrequired

The name of the rule that failed within the ruleset.

conditionIndexinteger (int64)

The index of the condition that failed.

effectIndexinteger (int64)

The index of the effect that failed.

detailsstring

More details about the failure.

evaluationGroupIDinteger (int64)

The ID of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-evaluation).

evaluationGroupModestring

The evaluation mode of the evaluation group. For more information, see [Managing campaign evaluation](https://docs.talon.one/docs/product/applications/managing-campaign-

createdCouponsarray<object>

The coupons that were created during the event processing.

idinteger (int64)required

The internal ID of the coupon.

createdstring (date-time)required

The time the coupon was created.

campaignIdinteger (int64)required

The ID of the campaign that owns this entity.

valuestringrequired

The coupon code.

usageLimitinteger (int64)required

The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.

discountLimitnumber

The total discount value that the code can give. Typically used to represent a gift card value.

reservationLimitinteger (int64)

The number of reservations that can be made with this coupon code.

startDatestring (date-time)

Timestamp at which point the coupon becomes valid.

expiryDatestring (date-time)

Expiration date of the coupon. Coupon never expires if this is omitted.

limitsarray<object>4 fields

Limits configuration for a coupon. These limits will override the limits set from the campaign. **Note:** Only usable when creating a single coupon which is not tied to a specific recipient. Only per-profile limits are allowed to be configured.

usageCounterinteger (int64)required

The number of times the coupon has been successfully redeemed.

discountCounternumber

The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon.

discountRemaindernumber

The remaining discount this coupon can give.

reservationCounternumber

The number of times this coupon has been reserved.

attributesobject

Custom attributes associated with this coupon.

referralIdinteger (int64)

The integration ID of the referring customer (if any) for whom this coupon was created as an effect.

recipientIntegrationIdstring

The Integration ID of the customer that is allowed to redeem this coupon.

importIdinteger (int64)

The ID of the Import which created this coupon.

reservationboolean

Defines the reservation type: - `true`: The coupon can be reserved for multiple customers. - `false`: The coupon can be reserved only for one customer. It is a personal code.

Default true

batchIdstring

The id of the batch the coupon belongs to.

isReservationMandatoryboolean

An indication of whether the code can be redeemed only if it has been reserved first.

Default false

implicitlyReservedboolean

An indication of whether the coupon is implicitly reserved for all customers.

createdReferralsarray<object>

The referrals that were created during the event processing.

idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

startDatestring (date-time)

Timestamp at which point the referral code becomes valid.

expiryDatestring (date-time)

Expiration date of the referral code. Referral never expires if this is omitted.

usageLimitinteger (int64)required

The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.

campaignIdinteger (int64)required

ID of the campaign from which the referral received the referral code.

advocateProfileIntegrationIdstringrequired

The Integration ID of the Advocate's Profile.

friendProfileIntegrationIdstring

An optional Integration ID of the Friend's Profile.

attributesobject

Arbitrary properties associated with this item.

importIdinteger (int64)

The ID of the Import which created this referral.

codestringrequired

The referral code.

usageCounterinteger (int64)required

The number of times this referral code has been successfully used.

batchIdstring

The ID of the batch the referrals belong to.

awardedGiveawaysarray<object>

The giveaways that were awarded during the event processing.

idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

codestringrequired

The code value of this giveaway.

poolIdinteger (int64)required

The ID of the pool to return giveaway codes from.

startDatestring (date-time)

Timestamp at which point the giveaway becomes valid.

endDatestring (date-time)

Timestamp at which point the giveaway becomes invalid.

attributesobject

Arbitrary properties associated with this giveaway.

usedboolean

Indicates whether this giveaway code was given before.

importIdinteger (int64)

The ID of the Import which created this giveaway.

profileIntegrationIdstring

The third-party integration ID of the customer profile that was awarded the giveaway, if the giveaway was awarded.

profileIdinteger (int64)

The internal ID of the customer profile that was awarded the giveaway, if the giveaway was awarded and an internal ID exists.

referralobject

idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

startDatestring (date-time)

Timestamp at which point the referral code becomes valid.

expiryDatestring (date-time)

Expiration date of the referral code. Referral never expires if this is omitted.

usageLimitinteger (int64)required

The number of times a referral code can be used. `0` means no limit but any campaign usage limits will still apply.

campaignIdinteger (int64)required

ID of the campaign from which the referral received the referral code.

advocateProfileIntegrationIdstringrequired

The Integration ID of the Advocate's Profile.

friendProfileIntegrationIdstring

An optional Integration ID of the Friend's Profile.

attributesobject

Arbitrary properties associated with this item.

importIdinteger (int64)

The ID of the Import which created this referral.

codestringrequired

The referral code.

usageCounterinteger (int64)required

The number of times this referral code has been successfully used.

batchIdstring

The ID of the batch the referrals belong to.

referredCustomersarray<string>required

An array of referred customers.

couponsarray<object>

The coupons that were processed.

idinteger (int64)required

The internal ID of the coupon.

createdstring (date-time)required

The time the coupon was created.

campaignIdinteger (int64)required

The ID of the campaign that owns this entity.

valuestringrequired

The coupon code.

usageLimitinteger (int64)required

The number of times the coupon code can be redeemed. `0` means unlimited redemptions but any campaign usage limits will still apply.

discountLimitnumber

The total discount value that the code can give. Typically used to represent a gift card value.

reservationLimitinteger (int64)

The number of reservations that can be made with this coupon code.

startDatestring (date-time)

Timestamp at which point the coupon becomes valid.

expiryDatestring (date-time)

Expiration date of the coupon. Coupon never expires if this is omitted.

limitsarray<object>4 fields

usageCounterinteger (int64)required

The number of times the coupon has been successfully redeemed.

discountCounternumber

The amount of discounts given on rules redeeming this coupon. Only usable if a coupon discount budget was set for this coupon.

discountRemaindernumber

The remaining discount this coupon can give.

reservationCounternumber

The number of times this coupon has been reserved.

attributesobject

Custom attributes associated with this coupon.

referralIdinteger (int64)

The integration ID of the referring customer (if any) for whom this coupon was created as an effect.

recipientIntegrationIdstring

The Integration ID of the customer that is allowed to redeem this coupon.

importIdinteger (int64)

The ID of the Import which created this coupon.

reservationboolean

Defines the reservation type: - `true`: The coupon can be reserved for multiple customers. - `false`: The coupon can be reserved only for one customer. It is a personal code.

Default true

batchIdstring

The id of the batch the coupon belongs to.

isReservationMandatoryboolean

An indication of whether the code can be redeemed only if it has been reserved first.

Default false

implicitlyReservedboolean

An indication of whether the coupon is implicitly reserved for all customers.

profileRedemptionCountinteger (int64)required

The number of times the coupon was redeemed by the profile.

eventobject

idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

applicationIdinteger (int64)required

The ID of the Application that owns this entity.

profileIdstring

ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`.

storeIntegrationIdstring

The integration ID of the store. You choose this ID when you create a store.

typestringrequired

A string representing the event. Must not be a reserved event name.

attributesobjectrequired

Arbitrary additional JSON data associated with the event.

sessionIdstring

The ID of the session that this event occurred in.

effectsarray<object>required

An array of effects generated by the rules of the enabled campaigns of the Application. You decide how to apply them in your system. See the list of [API effects](https://docs.talon.one/docs/dev/integration-api/api-effects).

ledgerEntriesarray<object>10 fields

Ledger entries for the event.

metaobject5 fields

advancedEventobject

profileIdstringrequired

ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`.

storeIntegrationIdstring

The integration ID of the store. You choose this ID when you create a store.

evaluableCampaignIdsarray<integer (int64)>

When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them.

integrationIdstringrequired

The unique ID of the current event. Only one event with this ID could be activated, duplicated events are forbidden.

typestringrequired

A string representing the event name. Must not be a reserved event name. You create this value when you [create an attribute](https://docs.talon.one/docs/dev/concepts/entities/events#creating-a-custom-event) of type `event` in the Campaign Manager.

attributesobject

Arbitrary additional JSON properties associated with the event. They must be created in the Campaign Manager before setting them with this property. See [creating custom attributes](https://docs.talon.one/docs/product/account/dev-tools/managing-attributes#creating-a-custom-attribute).

connectedSessionIDstring

The ID of the session that happened in the past.

previousEventIDstring

The unique identifier of the event that happened in the past.

customerSessionobject

The representation of the customer session.

idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

integrationIdstring (string)required

The integration ID set by your integration layer.

applicationIdinteger (int64)required

The ID of the Application that owns this entity.

profileIdstringrequired

ID of the customer profile set by your integration layer. **Note:** If the customer does not yet have a known `profileId`, we recommend you use a guest `profileId`.

storeIntegrationIdstring

The integration ID of the store. You choose this ID when you create a store.

evaluableCampaignIdsarray<integer (int64)>

couponCodesarray<string>

Any coupon codes entered. **Important - for requests only**: - If you [create a coupon budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a coupon code by the time you close it. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, omit the parameter entirely.

referralCodestring

Any referral code entered. **Important - for requests only**: - If you [create a referral budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign, ensure the session contains a referral code by the time you close it. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, omit the parameter entirely.

loyaltyCardsarray<string>

Identifier of a loyalty card.

statestringrequired

Indicates the current state of the session. Sessions can be created as `open` or `closed`. The state transitions are: 1. `open` → `closed` 2. `open` → `cancelled` 3. Either: - `closed` → `cancelled` (**only** via [Update customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/updateCustomerSessionV2)) or - `closed` → `partially_returned` (**only** via [Return cart items](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/returnCartItems)) - `closed` → `open` (**only** via [Reopen customer session](https://docs.talon.one/integration-api#tag/Customer-sessions/operation/reopenCustomerSession)) 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions).

One ofopenclosedpartially_returnedcancelledDefault "open"

cartItemsarray<object>required21 fields

The items to add to this session. **Do not exceed 1000 items** and ensure the sum of all cart item's `quantity` **does not exceed 10.000** per request.

experimentVariantAllocationsarray<object>2 fields

The experiment variant allocations to add to this session.

additionalCostsobject

Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs).

identifiersarray<string>

Session custom identifiers that you can set limits on or use inside your rules. For example, you can use IP addresses as identifiers to potentially identify devices and limit discounts abuse in case of customers creating multiple accounts. See the [tutorial](https://docs.talon.one/docs/dev/tutorials/using-identifiers). **Important**: Ensure the session contains an identifier by the time you close it if: - You [create a unique identifier budget](https://docs.talon.one/docs/product/campaigns/settings/managing-campaign-budgets/#budget-types) for your campaign. - Your campaign has [coupons](https://docs.talon.one/docs/product/campaigns/coupons/coupon-page-overview). - We recommend passing an anonymized (hashed) version of the identifier value.

attributesobjectrequired

Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attributes#built-in-attributes) or [custom ones](https://docs.talon.one/docs/dev/concepts/attributes#custom-attributes). Custom attributes must be created in the Campaign Manager before you set them with this property.

firstSessionbooleanrequired

Indicates whether this is the first session for the customer's profile. It's always `true` for anonymous sessions.

updateCountinteger (int64)required

The number of times the session was updated. When the session is created, this value is initialized to `1`.

totalnumberrequired

The total value of cart items and additional costs in the session, before any discounts are applied.

cartItemTotalnumberrequired

The total value of cart items, before any discounts are applied.

additionalCostTotalnumberrequired

The total value of additional costs, before any discounts are applied.

updatedstring (date-time)required

Timestamp of the most recent event received on this session.

returnobject

idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

applicationIdinteger (int64)required

The ID of the Application that owns this entity.

accountIdinteger (int64)required

The ID of the account that owns this entity.

returnedCartItemsarray<object>required3 fields

List of cart items to be returned.

eventIdinteger (int64)required

The event ID of that was generated for this return.

sessionIdinteger (int64)required

The internal ID of the session this return was requested on.

sessionIntegrationIdstringrequired

The integration ID of the session this return was requested on.

profileIdinteger (int64)

The internal ID of the profile this return was requested on.

profileIntegrationIdstring

The integration ID of the profile this return was requested on.

createdByinteger (int64)

ID of the user who requested this return.

previousReturnsarray<object>

The previous returns associated with the event.

idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

applicationIdinteger (int64)required

The ID of the Application that owns this entity.

accountIdinteger (int64)required

The ID of the account that owns this entity.

returnedCartItemsarray<object>required3 fields

List of cart items to be returned.

eventIdinteger (int64)required

The event ID of that was generated for this return.

sessionIdinteger (int64)required

The internal ID of the session this return was requested on.

sessionIntegrationIdstringrequired

The integration ID of the session this return was requested on.

profileIdinteger (int64)

The internal ID of the profile this return was requested on.

profileIntegrationIdstring

The integration ID of the profile this return was requested on.

createdByinteger (int64)

ID of the user who requested this return.

json

{
  "effects": [
    {
      "rulesetId": 73,
      "ruleIndex": 2,
      "campaignRevisionVersionId": 5,
      "campaignId": 244,
      "conditionIndex": 786,
      "evaluationGroupMode": "stackable",
      "effectType": "rejectCoupon",
      "adjustmentReferenceId": "68851723-e6fa-488f-ace9-112581e6c19b",
      "props": "{}",
      "selectedPrice": 100,
      "evaluationGroupID": 3,
      "triggeredForCatalogItem": 786,
      "selectedPriceType": "member",
      "campaignRevisionId": 1,
      "ruleName": "Give 20% discount",
      "experimentId": 12,
      "triggeredByCoupon": 4928
    }
  ],
  "createdCoupons": [
    {
      "recipientIntegrationId": "URNGV8294NV",
      "implicitlyReserved": false,
      "created": {},
      "campaignId": 211,
      "usageLimit": 100,
      "referralId": 326632952,
      "usageCounter": 10,
      "batchId": "32535-43255",
      "discountCounter": 10,
      "expiryDate": {},
      "importId": 4,
      "reservationLimit": 45,
      "reservationCounter": 1,
      "reservation": false,
      "attributes": "{}",
      "id": 6,
      "value": "XMAS-20-2021",
      "discountLimit": 30,
      "startDate": {},
      "limits": [
        {
          "period": "yearly",
          "entities": [
            "Coupon"
          ],
          "limit": 1000,
          "action": "createCoupon"
        },
        {
          "period": "yearly",
          "entities": [
            "Coupon"
          ],
          "limit": 1000,
          "action": "createCoupon"
        }
      ],
      "discountRemainder": 5,
      "isReservationMandatory": false
    }
  ],
  "createdReferrals": [
    {
      "code": "27G47Y54VH9L",
      "created": {},
      "usageLimit": 1,
      "campaignId": 78,
      "usageCounter": 1,
      "batchId": "tqyrgahe",
      "advocateProfileIntegrationId": "URNGV8294NV",
      "expiryDate": {},
      "importId": 4,
      "friendProfileIntegrationId": "BZGGC2454PA",
      "attributes": {
        "channel": "web"
      },
      "id": 6,
      "startDate": {}
    }
  ],
  "customerProfile": {
    "accountId": 31,
    "closedSessions": 3,
    "created": {},
    "sandbox": false,
    "integrationId": "URNGV8294NV",
    "attributes": {
      "Language": "english",
      "ShippingCountry": "DE"
    },
    "totalSales": 299.99,
    "lastActivity": {},
    "id": 6,
    "loyaltyMemberships": [
      {
        "joined": {},
        "loyaltyProgramId": 323414846
      },
      {
        "joined": {},
        "loyaltyProgramId": 323414846
      }
    ],
    "audienceMemberships": [
      {
        "name": "Travel audience",
        "id": 2
      },
      {
        "name": "Travel audience",
        "id": 2
      }
    ]
  },
  "loyalty": {
    "cards": [
      {
        "ledger": {
          "pendingBalance": 10,
          "nextTierName": "Silver",
          "negativeBalance": 10,
          "currentBalance": 100,
          "spentBalance": 0,
          "tentativeCurrentBalance": 100,
          "tentativePendingBalance": 20,
          "pointsToNextTier": 20,
          "expiredBalance": 0,
          "currentTier": {
            "expiryDate": {},
            "downgradePolicy": "one_down",
            "name": "bronze",
            "id": 11,
            "startDate": {}
          },
          "tentativeNegativeBalance": 100
        },
        "identifier": "summer-loyalty-card-0543",
        "oldCardIdentifier": "summer-loyalty-card-0543",
        "usersPerCardLimit": 111,
        "created": {},
        "profiles": [
          {
            "integrationId": "R195412",
            "timestamp": {}
          },
          {
            "integrationId": "R195412",
            "timestamp": {}
          }
        ],
        "subledgers": {
          "key": {
            "pendingBalance": 10,
            "nextTierName": "Silver",
            "negativeBalance": 10,
            "currentBalance": 100,
            "spentBalance": 0,
            "tentativeCurrentBalance": 100,
            "tentativePendingBalance": 20,
            "pointsToNextTier": 20,
            "expiredBalance": 0,
            "currentTier": {
              "expiryDate": {},
              "downgradePolicy": "one_down",
              "name": "bronze",
              "id": 11,
              "startDate": {}
            },
            "tentativeNegativeBalance": 100
          }
        },
        "batchId": "wdefpov",
        "programTitle": "Loyalty program",
        "programName": "Loyalty_program",
        "modified": {},
        "id": 6,
        "blockReason": "Current card lost. Customer needs a new card.",
        "newCardIdentifier": "summer-loyalty-card-0543",
        "programID": 125,
        "status": "active"
      },
      {
        "ledger": {
          "pendingBalance": 10,
          "nextTierName": "Silver",
          "negativeBalance": 10,
          "currentBalance": 100,
          "spentBalance": 0,
          "tentativeCurrentBalance": 100,
          "tentativePendingBalance": 20,
          "pointsToNextTier": 20,
          "expiredBalance": 0,
          "currentTier": {
            "expiryDate": {},
            "downgradePolicy": "one_down",
            "name": "bronze",
            "id": 11,
            "startDate": {}
          },
          "tentativeNegativeBalance": 100
        },
        "identifier": "summer-loyalty-card-0543",
        "oldCardIdentifier": "summer-loyalty-card-0543",
        "usersPerCardLimit": 111,
        "created": {},
        "profiles": [
          {
            "integrationId": "R195412",
            "timestamp": {}
          },
          {
            "integrationId": "R195412",
            "timestamp": {}
          }
        ],
        "subledgers": {
          "key": {
            "pendingBalance": 10,
            "nextTierName": "Silver",
            "negativeBalance": 10,
            "currentBalance": 100,
            "spentBalance": 0,
            "tentativeCurrentBalance": 100,
            "tentativePendingBalance": 20,
            "pointsToNextTier": 20,
            "expiredBalance": 0,
            "currentTier": {
              "expiryDate": {},
              "downgradePolicy": "one_down",
              "name": "bronze",
              "id": 11,
              "startDate": {}
            },
            "tentativeNegativeBalance": 100
          }
        },
        "batchId": "wdefpov",
        "programTitle": "Loyalty program",
        "programName": "Loyalty_program",
        "modified": {},
        "id": 6,
        "blockReason": "Current card lost. Customer needs a new card.",
        "newCardIdentifier": "summer-loyalty-card-0543",
        "programID": 125,
        "status": "active"
      }
    ],
    "programs": {
      "key": {
        "ledger": {
          "pendingBalance": 10,
          "nextTierName": "Silver",
          "negativeBalance": 10,
          "currentBalance": 100,
          "spentBalance": 0,
          "tentativeCurrentBalance": 100,
          "tentativePendingBalance": 20,
          "pointsToNextTier": 20,
          "expiredBalance": 0,
          "currentTier": {
            "expiryDate": {},
            "downgradePolicy": "one_down",
            "name": "bronze",
            "id": 11,
            "startDate": {}
          },
          "tentativeNegativeBalance": 100
        },
        "joinDate": {},
        "subLedgers": {
          "key": {
            "pendingBalance": 10,
            "nextTierName": "Silver",
            "negativeBalance": 10,
            "currentBalance": 100,
            "spentBalance": 0,
            "tentativeCurrentBalance": 100,
            "tentativePendingBalance": 20,
            "pointsToNextTier": 20,
            "expiredBalance": 0,
            "currentTier": {
              "expiryDate": {},
              "downgradePolicy": "one_down",
              "name": "bronze",
              "id": 11,
              "startDate": {}
            },
            "tentativeNegativeBalance": 100
          }
        },
        "name": "program1",
        "id": 5,
        "title": "My loyalty program"
      }
    }
  },
  "triggeredCampaigns": [
    {
      "type": "advanced",
      "templateId": 3,
      "customEffectCount": 0,
      "activeRevisionId": 6,
      "features": [
        "coupons",
        "referrals"
      ],
      "createdLoyaltyPointsCount": 9,
      "storesImported": true,
      "couponSettings": {
        "couponPattern": "SUMMER-####-####",
        "validCharacters": [
          "A",
          "B",
          "C",
          "D",
          "E",
          "F",
          "G",
          "H",
          "I",
          "J",
          "K",
          "L",
          "M",
          "N",
          "O",
          "P",
          "Q",
          "R",
          "S",
          "T",
          "U",
          "V",
          "W",
          "X",
          "Y",
          "Z",
          "0",
          "1",
          "2",
          "3",
          "4",
          "5",
          "6",
          "7",
          "8",
          "9"
        ]
      },
      "experimentId": 1,
      "id": 4,
      "state": "enabled",
      "couponAttributes": "{}",
      "reservecouponEffectCount": 9,
      "updatedBy": "Jane Doe",
      "frontendState": "running",
      "created": {},
      "referralCreationCount": 8,
      "stageRevision": false,
      "couponRedemptionCount": 163,
      "couponCreationCount": 16,
      "version": 6,
      "campaignGroups": [
        1,
        3
      ],
      "tags": [
        "summer"
      ],
      "discountEffectCount": 343,
      "budgets": [
        {
          "limit": 1000,
          "action": "createCoupon",
          "counter": 42
        },
        {
          "limit": 1000,
          "action": "createCoupon",
          "counter": 42
        }
      ],
      "redeemedLoyaltyPointsCount": 8,
      "name": "Summer promotions",
      "valueMapsIds": [
        100,
        215
      ],
      "applicationId": 322,
      "updated": {},
      "callApiEffectCount": 0,
      "createdLoyaltyPointsEffectCount": 2,
      "discountCount": 288,
      "revisionFrontendState": "revised",
      "description": "Campaign for all summer 2021 promotions",
      "activeRevisionVersionId": 6,
      "currentRevisionVersionId": 6,
      "startTime": {},
      "currentRevisionId": 6,
      "limits": [
        {
          "period": "yearly",
          "entities": [
            "Coupon"
          ],
          "limit": 1000,
          "action": "createCoupon"
        },
        {
          "period": "yearly",
          "entities": [
            "Coupon"
          ],
          "limit": 1000,
          "action": "createCoupon"
        }
      ],
      "activeRulesetId": 6,
      "reevaluateOnReturn": true,
      "userId": 388,
      "awardedGiveawaysCount": 9,
      "redeemedLoyaltyPointsEffectCount": 9,
      "linkedStoreIds": [
        1,
        2,
        3
      ],
      "createdBy": "John Doe",
      "addFreeItemEffectCount": 0,
      "referralSettings": {
        "couponPattern": "SUMMER-####-####",
        "validCharacters": [
          "A",
          "B",
          "C",
          "D",
          "E",
          "F",
          "G",
          "H",
          "I",
          "J",
          "K",
          "L",
          "M",
          "N",
          "O",
          "P",
          "Q",
          "R",
          "S",
          "T",
          "U",
          "V",
          "W",
          "X",
          "Y",
          "Z",
          "0",
          "1",
          "2",
          "3",
          "4",
          "5",
          "6",
          "7",
          "8",
          "9"
        ]
      },
      "attributes": "{}",
      "lastActivity": {},
      "endTime": {},
      "referralRedemptionCount": 3
    }
  ],
  "ruleFailureReasons": [
    {
      "rulesetID": 6,
      "ruleIndex": 5,
      "campaignID": 0,
      "referralID": 1,
      "conditionIndex": 5,
      "effectIndex": 2,
      "evaluationGroupMode": "stackable",
      "couponID": 4928,
      "referralValue": "referralValue",
      "couponValue": "couponValue",
      "evaluationGroupID": 3,
      "ruleName": "ruleName",
      "details": "details",
      "campaignName": "campaignName"
    }
  ],
  "awardedGiveaways": [
    {
      "profileIntegrationId": "R195412",
      "code": "GIVEAWAY1",
      "importId": 4,
      "endDate": {},
      "created": {},
      "profileId": 1,
      "poolId": 1,
      "attributes": "{}",
      "id": 6,
      "used": true,
      "startDate": {}
    }
  ],
  "referral": {
    "code": "27G47Y54VH9L",
    "created": {},
    "usageLimit": 1,
    "campaignId": 78,
    "usageCounter": 1,
    "batchId": "tqyrgahe",
    "advocateProfileIntegrationId": "URNGV8294NV",
    "expiryDate": {},
    "importId": 4,
    "friendProfileIntegrationId": "BZGGC2454PA",
    "attributes": {
      "channel": "web"
    },
    "referredCustomers": [
      "referredCustomers",
      "referredCustomers"
    ],
    "id": 6,
    "startDate": {}
  },
  "coupons": [
    {
      "recipientIntegrationId": "URNGV8294NV",
      "implicitlyReserved": false,
      "created": {},
      "campaignId": 211,
      "usageLimit": 100,
      "referralId": 326632952,
      "profileRedemptionCount": 5,
      "usageCounter": 10,
      "batchId": "32535-43255",
      "discountCounter": 10,
      "expiryDate": {},
      "importId": 4,
      "reservationLimit": 45,
      "reservationCounter": 1,
      "reservation": false,
      "attributes": "{}",
      "id": 6,
      "value": "XMAS-20-2021",
      "discountLimit": 30,
      "startDate": {},
      "limits": [
        {
          "period": "yearly",
          "entities": [
            "Coupon"
          ],
          "limit": 1000,
          "action": "createCoupon"
        },
        {
          "period": "yearly",
          "entities": [
            "Coupon"
          ],
          "limit": 1000,
          "action": "createCoupon"
        }
      ],
      "discountRemainder": 5,
      "isReservationMandatory": false
    }
  ],
  "event": {
    "effects": [
      "{}",
      "{}"
    ],
    "storeIntegrationId": "STORE-001",
    "created": {},
    "profileId": "URNGV8294NV",
    "meta": {
      "campaigns": "{}",
      "coupons": "{}",
      "referralRejectionReason": {
        "reason": "ReferralNotFound",
        "campaignId": 3,
        "referralId": 2
      },
      "warnings": "{}",
      "couponRejectionReason": {
        "reason": "CouponNotFound",
        "campaignId": 244,
        "couponId": 4928
      }
    },
    "ledgerEntries": [
      {
        "expiryDate": {},
        "accountId": 7,
        "eventId": 3,
        "reason": "Customer appeasement.",
        "amount": 100,
        "created": {},
        "profileId": "URNGV8294NV",
        "loyaltyProgramId": 323414846,
        "id": 6,
        "referenceId": 9
      },
      {
        "expiryDate": {},
        "accountId": 7,
        "eventId": 3,
        "reason": "Customer appeasement.",
        "amount": 100,
        "created": {},
        "profileId": "URNGV8294NV",
        "loyaltyProgramId": 323414846,
        "id": 6,
        "referenceId": 9
      }
    ],
    "attributes": {
      "myAttribute": "myValue"
    },
    "id": 6,
    "sessionId": "175KJPS947296",
    "applicationId": 322,
    "type": "pageViewed"
  },
  "advancedEvent": {
    "connectedSessionID": "175KJPS947296",
    "storeIntegrationId": "STORE-001",
    "profileId": "URNGV8294NV",
    "evaluableCampaignIds": [
      10,
      12
    ],
    "previousEventID": "175KJPS947296",
    "integrationId": "175KJPS947296",
    "attributes": {
      "myAttribute": "myValue"
    },
    "type": "pageViewed"
  }
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?