TAtalon
Customer data

Get Application session

[!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.

Get the details of the given session. You can list the sessions with the List Application sessions endpoint.

get/v1/applications/{applicationId}/sessions/{sessionId}

Request

Path parameters

applicationIdinteger required

The ID of the Application. It is displayed in your Talon.One deployment URL.

sessionIdinteger required

The internal ID of the session. You can get the ID with the List Application sessions endpoint.

Response

OK

idinteger 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.

storeIntegrationIdstring

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

applicationIdinteger required

The ID of the Application that owns this entity.

profileIdinteger

The globally unique Talon.One ID of the customer that created this entity.

profileintegrationidstring

Integration ID of the customer for the session.

couponstring required

Any coupon code entered.

referralstring required

Any referral code entered.

state'open' | 'closed' | 'partially_returned' | 'cancelled' required

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. closed -> cancelled or partially_returned
  4. partially_returned -> cancelled

For more information, see Customer session states.

discountsobject required

API V1 only. A map of labeled discount values, in the same currency as the session.

If you are using the V2 endpoints, refer to the totalDiscounts property instead.

totalDiscountsnumber required

The total sum of the discounts applied to this session.

Note: If more than one session is returned, this value is displayed as 0.

totalnumber required

The total sum of the session before any discounts applied.

attributesobject

Arbitrary properties associated with this item.

Example response

{
  "id": 6,
  "created": "2020-02-07T08:15:22Z",
  "integrationId": "URNGV8294NV",
  "storeIntegrationId": "STORE-001",
  "applicationId": 322,
  "profileId": 138,
  "profileintegrationid": "382370BKDB946",
  "coupon": "BKDB946",
  "referral": "BKDB946",
  "state": "closed",
  "cartItems": [
    {
      "name": "Air Glide",
      "sku": "SKU1241028",
      "quantity": 1,
      "returnedQuantity": 1,
      "remainingQuantity": 1,
      "price": 99.99,
      "category": "shoes",
      "product": {
        "name": "sample_product"
      },
      "weight": 1130,
      "attributes": {
        "image": "11.jpeg",
        "material": "leather"
      },
      "additionalCosts": {
        "shipping": {
          "price": 9
        }
      },
      "selectedPriceType": "member",
      "adjustmentReferenceId": "68851723-e6fa-488f-ace9-112581e6c19b",
      "adjustmentEffectiveFrom": "2021-09-12T10:12:42Z",
      "adjustmentEffectiveUntil": "2021-09-12T10:12:42Z",
      "prices": {
        "member": {
          "price": 90,
          "adjustmentReferenceId": "68851723-e6fa-488f-ace9-112581e6c19b",
          "effectiveFrom": "2025-05-25T00:00:00Z",
          "effectiveUntil": "2025-05-30T00:00:00Z"
        },
        "base": {
          "price": 100
        }
      }
    }
  ],
  "totalDiscounts": 100,
  "total": 200
}

Changes

No recorded changes to this operation across all 2 revisions of this API.