younifyd
Menu

Get Application Sessions

List Application sessions

GET/v1/applications/{applicationId}/sessions

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Get Application Sessions action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{getApplicationSessions.response.data}}.

Request

Path parameters

applicationIdinteger (int64)required

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

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.

partialMatchboolean

Enables partial matching for a single text search field. When enabled, the search term matches anywhere within the field value (case-insensitive). Minimum 3 characters required for partial matches; shorter inputs automatically fall back to exact match. **Note:** Use with one of: `integrationId`, `profile`, `coupon`, `referral`, or `storeIntegrationId`.

Default false

profilestring

Filter by sessions with this profile integration ID. By default, requires exact match. Use `partialMatch=true` to search for partial matches (minimum 3 characters).

statestring

Filter by sessions with this state. Must be exact match.

One ofopenclosedpartially_returnedcancelled

createdBeforestring (date-time)

Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.

createdAfterstring (date-time)

Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.

couponstring

Filter by sessions with this coupon. By default, requires exact match. Use `partialMatch=true` to search for partial matches (minimum 3 characters).

referralstring

Filter by sessions with this referral. By default, requires exact match. Use `partialMatch=true` to search for partial matches (minimum 3 characters).

integrationIdstring

Filter by sessions with this integration ID. By default, requires exact match. Use `partialMatch=true` to search for partial matches (minimum 3 characters).

storeIntegrationIdstring

The integration ID of the store. You choose this ID when you create a store. By default, requires exact match. Use `partialMatch=true` to search for partial matches (minimum 3 characters).

Response

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

hasMoreboolean
dataarray<object>
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.

storeIntegrationIdstring

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

applicationIdinteger (int64)required

The ID of the Application that owns this entity.

profileIdinteger (int64)

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

profileintegrationidstring

Integration ID of the customer for the session.

couponstringrequired

Any coupon code entered.

referralstringrequired

Any referral code entered.

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. `closed` → `cancelled` or `partially_returned` 4. `partially_returned` → `cancelled` For more information, see [Customer session states](https://docs.talon.one/docs/dev/concepts/entities/customer-sessions).

One ofopenclosedpartially_returnedcancelled

cartItemsarray<object>required21 fields

Serialized JSON representation.

discountsobjectrequired

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

totalDiscountsnumberrequired

The total sum of the discounts applied to this session. **Note:** If more than one session is returned, this value is displayed as `0`.

totalnumberrequired

The total sum of the session before any discounts applied.

attributesobject

Arbitrary properties associated with this item.

json
{
  "data": [
    {
      "coupon": "BKDB946",
      "created": {},
      "totalDiscounts": 100,
      "integrationId": "URNGV8294NV",
      "profileintegrationid": "382370BKDB946",
      "total": 200,
      "referral": "BKDB946",
      "discounts": {
        "key": 0.8008281904610115
      },
      "storeIntegrationId": "STORE-001",
      "profileId": 138,
      "attributes": "{}",
      "id": 6,
      "state": "closed",
      "applicationId": 322,
      "cartItems": [
        {
          "remainingQuantity": 1,
          "product": {
            "name": "sample_product"
          },
          "quantity": 1,
          "returnedQuantity": 1,
          "length": 1.4658129805029452,
          "weight": 1130,
          "adjustmentReferenceId": "68851723-e6fa-488f-ace9-112581e6c19b",
          "adjustmentEffectiveFrom": {},
          "catalogItemID": 5,
          "additionalCosts": {
            "shipping": {
              "price": 9
            }
          },
          "price": 99.99,
          "selectedPriceType": "member",
          "name": "Air Glide",
          "width": 6.027456183070403,
          "attributes": {
            "image": "11.jpeg",
            "material": "leather"
          },
          "adjustmentEffectiveUntil": {},
          "position": 5.962133916683182,
          "sku": "SKU1241028",
          "category": "shoes",
          "prices": {
            "member": {
              "price": 90,
              "adjustmentReferenceId": "68851723-e6fa-488f-ace9-112581e6c19b",
              "effectiveFrom": {},
              "effectiveUntil": {}
            },
            "base": {
              "price": 100
            }
          },
          "height": 0.8008281904610115
        },
        {
          "remainingQuantity": 1,
          "product": {
            "name": "sample_product"
          },
          "quantity": 1,
          "returnedQuantity": 1,
          "length": 1.4658129805029452,
          "weight": 1130,
          "adjustmentReferenceId": "68851723-e6fa-488f-ace9-112581e6c19b",
          "adjustmentEffectiveFrom": {},
          "catalogItemID": 5,
          "additionalCosts": {
            "shipping": {
              "price": 9
            }
          },
          "price": 99.99,
          "selectedPriceType": "member",
          "name": "Air Glide",
          "width": 6.027456183070403,
          "attributes": {
            "image": "11.jpeg",
            "material": "leather"
          },
          "adjustmentEffectiveUntil": {},
          "position": 5.962133916683182,
          "sku": "SKU1241028",
          "category": "shoes",
          "prices": {
            "member": {
              "price": 90,
              "adjustmentReferenceId": "68851723-e6fa-488f-ace9-112581e6c19b",
              "effectiveFrom": {},
              "effectiveUntil": {}
            },
            "base": {
              "price": 100
            }
          },
          "height": 0.8008281904610115
        }
      ]
    }
  ],
  "hasMore": false
}

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