Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Talon.One Customer Sessions API

Integration API - create and update customer sessions and receive effects.

Talon.One Customer Sessions API is one of 13 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, API documentation, and an API reference.

This API exposes 4 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://yourbaseurl.talon.one.

4 operations 3 paths 6 schemas 1 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://yourbaseurl.talon.one
Authentication
API Key, API Key
Contact
Resource Areas
1

Authentication & Security 2

Talon.One Customer Sessions API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (integrationKey). An API key is passed in the header as Authorization (managementKey). By default, every request must be authenticated.

  • integrationKey — Integration API key with the ApiKey-v1 prefix, e.g. header "Authorization: ApiKey-v1 ".
  • managementKey — Management API key with the ManagementKey-v1 prefix, e.g. header "Authorization: ManagementKey-v1 ".

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

Integration API - create and update customer sessions and receive effects.

GET
/v2/customer_sessions/{customerSessionId}
Get customer session
getCustomerSession 1 param → 200401
PUT
/v2/customer_sessions/{customerSessionId}
Update customer session
updateCustomerSessionV2 1 param body → 200401
PUT
/v2/customer_sessions/{customerSessionId}/reopen
Reopen customer session
reopenCustomerSession 1 param → 200
POST
/v2/customer_sessions/{customerSessionId}/returns
Return cart items
returnCartItems 1 param body → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are CustomerSession (8 properties), CartItem (5 properties), Effect (4 properties), IntegrationStateV2 (3 properties). Each schema is shown below with its type and property counts.

IntegrationRequest
object
A wrapper carrying the customer session payload and response controls.
2 properties
CartItem
object
5 properties
CustomerSession
object
A customer session evaluated against the Application's campaigns.
8 properties
IntegrationStateV2
object
The evaluated session plus the effects to apply in the caller.
3 properties
Error
object
2 properties
Effect
object
A single effect returned by the rules engine (e.g. setDiscount, acceptCoupon, addLoyaltyPoints).
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

talon-one-customer-sessions-api-openapi.yml Raw ↑

Other APIs Talon.One publishes across the network.

Talon.One Account API
Talon.One Applications API
Talon.One Attributes API
Talon.One Audiences API
Talon.One Campaigns API
Talon.One Collections API
Talon.One Coupons API
Talon.One Customer Profiles API
Talon.One Events API
Talon.One Exports API
Talon.One Loyalty API
Talon.One Referrals API