Talon.One Customer sessions API
Represents the data related to a customer session. Typically, a customer session is the value and content of the customer's cart.Sessions can be anonymous or linked to a customer profile and they have a life cycle from `open` to `closed`.In general, a session is closed when the customer completes the checkout step.Sessions are a key concept of Talon.One. We strongly recommend you read the [documentation about customer sessions](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions).
Talon.One Customer sessions API is one of 42 APIs that Talon.One publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Customer Sessions. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.
This API exposes 4 operations across 3 paths, and defines 124 schemas. It is described by OpenAPI 3.2.0.
Requests are made against a single base URL, https://yourbaseurl.talon.one.
4 operations
3 paths
124 schemas
1 GET1 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Talon.One Customer sessions API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (api_key_v1).
By default, every request must be authenticated.
api_key_v1— To authenticate with the Integration API, generate an API key in the Campaign Manager and prefix it with ApiKey-v1. To generate an API key: 1. Sign in to the C…
Paths & Operations 4
Across 3 paths, the API surfaces 4 operations — 1 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Customer Sessions 4
Represents the data related to a customer session. Typically, a customer session is the value and content of the customer's cart. Sessions can be anonymous or linked to a customer…
PUT
/v2/customer_sessions/{customerSessionId}
Update customer session
GET
/v2/customer_sessions/{customerSessionId}
Get customer session
POST
/v2/customer_sessions/{customerSessionId}/returns
Return cart items
PUT
/v2/customer_sessions/{customerSessionId}/reopen
Reopen customer session
Schemas 124
The contract defines 124 schemas that model the data the API accepts and returns. The most detailed are AdditionalCampaignProperties (25 properties), CartItem (21 properties), BaseCampaign (17 properties), AddLoyaltyPointsEffectProps (16 properties). Each schema is shown below with its type and property counts.
ShowBundleMetadataEffectProps
object
This effect is deprecated. The ShowBundleMetadata effect contains information that allows you to associate the discounts from a rule in a bundle campaign with…
3 properties
3 required
CustomerProfile
ErrorEffectProps
object
This effect is triggered whenever an error occurs during rule evaluation. This effect only provides information about what the error is.
1 property
1 required
RuleEligibilityFailureDetails
object
The details about why the customer was not eligible for the rule in the current session.
8 properties
2 required
EvaluableCampaignIds
object
1 property
AdditionalCampaignProperties
object
25 properties
5 required
StartAchievementProgressEffectProps
object
This effect indicates that the customer's progress in an achievement was started during the current session. The progress value is set to 0. It is triggered wh…
6 properties
5 required
CampaignEligibility
LoyaltyCardProfileRegistration
object
2 properties
2 required
AchievementProgress
object
The current progress of the customer in the achievement.
5 properties
2 required
IntegrationResponse
object
Contains entities that might be valuable in Talon.One integrations.
10 properties
3 required
AddFreeItemEffectProps
object
This effect indicates that a free item should be added to the shopping cart in the current session. In this example, add the SKU to the shopping cart and set i…
3 properties
2 required
CustomerSessionV2
CouponLimitConfigs
object
1 property
CustomerAchievement
object
A customer's progress in an achievement, together with the achievement definition.
11 properties
9 required
Referral
CampaignVersions
object
7 properties
AcceptCouponEffectProps
object
This effect indicates that the coupon code supplied was valid. You should handle this effect by clearing any messages from previous rejectCoupon effects and in…
1 property
1 required
RemoveFromAudienceEffectProps
object
This effect is triggered when a rule containing an [Update audience](https://docs.talon.one/docs/product/rules/effects/use-effectsupdate-an-audience) effect wi…
4 properties
AwardGiveawayEffectProps
object
This effect indicates the awarded giveaway item and to which profile the item was awarded. Learn more about [giveaways](https://docs.talon.one/docs/product/giv…
5 properties
5 required
Entity
object
2 properties
2 required
RollbackDeductedLoyaltyPointsEffectProps
object
This effect is triggered in the following cases: - A session is cancelled and this session deducted loyalty points. The rollback action returns the redeemed lo…
8 properties
5 required
APIError
object
3 properties
2 required
ReferralRejectionReason
object
Holds a reference to the campaign, the referral and the reason for which that referral was rejected. Should only be present when there is a 'rejectReferral' ef…
3 properties
3 required
Campaign
WillAwardGiveawayEffectProps
object
The equivalent of the awardGiveaway effect but returned when updating a session with any state other than closed. This ensures no giveaway codes are leaked whe…
3 properties
3 required
CouponEntity
object
2 properties
2 required
AddLoyaltyPointsEffectProps
object
This effect indicates that a defined amount of loyalty points was successfully added to the customer's profile or to a loyalty card. If you use the [Add loyalt…
16 properties
6 required
CartItem
object
21 properties
2 required
UserEntity
object
1 property
1 required
Giveaway
Meta
object
5 properties
CouponRejectionReason
object
Holds a reference to the campaign, the coupon and the reason for which that coupon was rejected. Should only be present when there is a 'rejectCoupon' effect.
3 properties
3 required
AddToAudienceEffectProps
object
This effect is triggered when a rule containing an [Update audience](https://docs.talon.one/docs/product/rules/effects/use-effectsupdate-an-audience) effect wi…
4 properties
InventoryReferral
EffectEntity
object
Definition of all properties that are present on all effects, independent of their type.
16 properties
5 required
AcceptReferralEffectProps
object
This effect indicates that the referral code supplied is valid. You should handle this effect by informing the user that the referral code is valid. The code i…
1 property
1 required
SetDiscountPerAdditionalCostPerItemEffectProps
object
This effect indicates that a discount of a specific additional cost within a specific item should be applied. It gets triggered whenever a rule containing a Di…
7 properties
5 required
CouponCreatedEffectProps
object
This effect indicates that a coupon was created. For referrals and retention marketing, a common use case is to generate a coupon that can only be redeemed by…
2 properties
2 required
ShowNotificationEffectProps
object
You can use notifications to inform customers of certain events. There are four types of notification messages: - Info - Offer - Error - Misc It is up to you t…
3 properties
3 required
ReturnIntegrationRequest
object
The body of a return integration API request. Next to the cart items details, this contains an optional listing of extra properties that should be returned in…
2 properties
1 required
ExtendLoyaltyPointsExpiryDateEffectProps
object
If loyalty points have an expiry date, this effect extends the expiry of all active and pending point transactions by a selected duration.
4 properties
4 required
UpdateAttributeEffectProps
object
This effect indicates that a rule containing an [Update attribute value](https://docs.talon.one/docs/product/rules/effects/available-effectsupdate-effects) or…
2 properties
2 required
PriceDetail
object
5 properties
CodeGeneratorSettings
object
2 properties
2 required
RollbackDiscountEffectProps
object
This effect indicates that a discounted session, cart item, or additional cost has been cancelled or partially returned. This effect can only happen when you s…
7 properties
2 required
LedgerInfo
TriggerWebhookEffectProps
object
This effect is triggered when a rule containing a [webhook effect](https://docs.talon.one/docs/product/rules/effects/available-effectswebhooks) is validated. T…
2 properties
2 required
AudienceMembership
object
2 properties
2 required
RedeemReferralEffectProps
object
This effect is deprecated. It has been replaced by the acceptReferral effect. This effect indicates that the referral code is valid and has been redeemed.
2 properties
2 required
NewCustomerSessionV2
The representation of the customer session.
RuleFailureReason
object
Details about why a rule failed.
14 properties
5 required
LoyaltyCard
LoyaltyMembership
object
2 properties
1 required
LoyaltyProgramEntity
object
3 properties
1 required
CampaignEligibilityFailureDetails
object
The details about why the customer was not eligible for the campaign in the current session.
1 property
1 required
Coupon
ReserveCouponEffectProps
object
This effect indicates that the given coupon code was reserved for the given customer. Talon.One provides soft and hard reservations. For more information, see…
3 properties
3 required
CampaignBudget
object
3 properties
3 required
IntegrationCustomerSessionResponse
object
2 properties
Event
EventV3Entity
object
1 property
ErrorResponseWithStatus
object
3 properties
LoyaltyCardIdentifier
string
The identifier of the loyalty card, which must match the regular expression ^[A-Za-z0-9.%+@-]+$.
RollbackCouponEffectProps
object
This effect indicates that a coupon code redemption has been rolled back. The coupon becomes redeemable again. The effect is triggered when you [cancel](https:…
1 property
1 required
RejectReferralEffectProps
object
This effect indicates that the provided referral code is invalid.
6 properties
2 required
RejectCouponEffectProps
object
This effect indicates that the coupon code supplied couldn't be used. You should handle this effect by informing their user the coupon code is invalid.
6 properties
2 required
IntegrationEntity
object
2 properties
2 required
IntegrationCoupon
LoyaltyLedgerEntryExpiryDateChange
object
The properties specific to effects for changing the expiry dates of loyalty ledger entries.
3 properties
2 required
LimitConfig
object
4 properties
3 required
EventV3
Return
ReopenSessionResponse
object
This is the response type returned by the Reopen customer sessions endpoint. It contains the rolled back effects.
1 property
1 required
RuleMetadata
object
4 properties
1 required
IntegrationStoreEntity
object
1 property
CustomEffectProps
object
If you want to return data as an effect but no effect matches your use case, you can [create a custom effect](https://docs.talon.one/docs/dev/tutorials/create-…
7 properties
3 required
SetDiscountPerItemEffectProps
object
This effect schema is returned when you use the Discount individual items, Discount individual items pro rata, or Discount individual item in bundles effect in…
13 properties
3 required
LoyaltyProgramBalance
object
The balance in a Loyalty Program for some Customer.
8 properties
5 required
UpdateLoyaltyCard
object
2 properties
1 required
IntegrationStateV2
ImportEntity
object
1 property
LoyaltyProgramLedgers
object
Customer-specific information about loyalty points.
6 properties
4 required
ChangeLoyaltyTierLevelEffectProps
object
This effect indicates that a customer's loyalty tier has been upgraded. This effect is generated only when the [Add loyalty points](https://docs.talon.one/docs…
6 properties
4 required
ErrorSource
object
The source of the current error, exactly one of pointer, parameter or line will be defined.
4 properties
CustomerProfileEntity
object
2 properties
2 required
RollbackIncreasedAchievementProgressEffectProps
object
This effect indicates that the customer's progress in an achievement was rolled back. The Rule Engine triggers this effect when you cancel or [reopen a custome…
6 properties
6 required
NewCustomerProfile
object
1 property
AccountEntity
object
1 property
1 required
CouponValue
object
1 property
IntegrationRequest
object
The body of a V2 integration API request (customer session update). Next to the customer session details, this contains an optional listing of extra properties…
2 properties
1 required
Loyalty
object
Customer-specific information about loyalty points.
2 properties
1 required
Product
object
The specific properties of the product this item belongs to, if available.
1 property
1 required
DeductLoyaltyPointsEffectProps
object
This effect is triggered when a customer redeems loyalty points. The points are deducted from their active point balance. If the loyalty program is card-based,…
7 properties
6 required
IntegrationProfileEntity
object
1 property
NewReturn
object
1 property
1 required
NewReferral
CouponConstraints
object
5 properties
Tier
object
5 properties
2 required
IncreaseAchievementProgressEffectProps
object
This effect indicates that the customer's progress in an achievement was updated during the current session. It is triggered when a rule using the [Update cust…
7 properties
6 required
RollbackAddedLoyaltyPointsEffectProps
object
This effect is triggered in the following cases: - A session was cancelled in which loyalty points have been added. - A session was partially returned and loya…
8 properties
5 required
ReferralConstraints
object
3 properties
CampaignEligibilityDetails
object
3 properties
1 required
ApplicationEntity
object
1 property
1 required
EntityWithTalangVisibleID
object
2 properties
2 required
CampaignEntity
object
1 property
1 required
RuleMetadataEligibility
Effect
ReferralCreatedEffectProps
object
The referralCreated effect behaves similarly to [couponCreated](https://docs.talon.one/docs/dev/integration-api/api-effectscouponcreated). If the friendProfile…
1 property
1 required
CampaignEligibilityExperiment
object
The identifiers for the [experiment](https://docs.talon.one/management-apitag/Experiments) and the variant assigned to the customer profile. Only returned when…
2 properties
2 required
SetLoyaltyPointsExpiryDateEffectProps
object
This effect updates the expiry date of all active, pending, and unlimited point transactions to a specific date.
4 properties
3 required
SetDiscountEffectProps
object
This effect indicates that a discount should be set on the total shopping cart value of the current order with the given label and amount. The discount should…
4 properties
2 required
IntegrationEvent
EventV3Connections
object
1 property
ReturnedCartItem
object
3 properties
LedgerEntry
AdditionalCost
object
1 property
1 required
BaseCampaign
object
17 properties
5 required
ErrorResponse
object
2 properties
1 required
SetDiscountPerAdditionalCostEffectProps
object
This effect indicates that a discount that should be applied on a specific additional cost. It is triggered whenever a rule containing a Discount additional co…
5 properties
4 required
IntegrationCampaignBase
ExperimentVariantAllocation
object
2 properties
2 required
RollbackReferralEffectProps
object
This effect indicates that the redemption of the referral code has been rolled back. It triggers when a closed session that redeemed a referral is gets cancell…
1 property
1 required
RuleEligibility
object
The customer's eligibility for a rule in the current session, based on whether all of the rule's conditions were met.
3 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Talon.One 12
Other APIs Talon.One publishes across the network.
Talon.One Accounts and users API
Talon.One Achievements API
Talon.One Additional costs API
Talon.One Analytics API
Talon.One Applications API
Talon.One Attributes API
Talon.One Audiences API
Talon.One Braze API
Talon.One Campaign access groups API
Talon.One Campaign notifications API
Talon.One Campaign templates API
Talon.One Campaigns API
#Customer Sessions
Where this information came from
This is an independent, third-party profile of Talon.One Customer sessions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.