| Name | Type | Description | Notes |
|---|---|---|---|
| integrationId | String | The integration ID set by your integration layer. | |
| created | OffsetDateTime | The time this entity was created. | |
| applicationId | Integer | The ID of the application that owns this entity. | |
| profileId | String | 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`. | |
| coupon | String | Any coupon code entered. | |
| referral | String | Any referral code entered. | |
| state | StateEnum | 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. | |
| cartItems | List<CartItem> | Serialized JSON representation. | |
| identifiers | List<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. | [optional] |
| total | BigDecimal | The total sum of the cart in one session. | |
| attributes | Object | A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. | |
| firstSession | Boolean | Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. | |
| discounts | Map<String, BigDecimal> | A map of labelled discount values, values will be in the same currency as the application associated with the session. | |
| updated | OffsetDateTime | Timestamp of the most recent event received on this session. |
| Name | Value |
|---|---|
| OPEN | "open" |
| CLOSED | "closed" |
| PARTIALLY_RETURNED | "partially_returned" |
| CANCELLED | "cancelled" |