| id |
int |
Internal ID of this entity. |
|
| created |
datetime |
The time this entity was created. The time this entity was created. |
|
| integration_id |
str |
The integration ID set by your integration layer. |
|
| application_id |
int |
The ID of the application that owns this entity. |
|
| profile_id |
str |
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`. |
|
| store_integration_id |
str |
The integration ID of the store. You choose this ID when you create a store. |
[optional] |
| evaluable_campaign_ids |
list[int] |
When using the `dry` query parameter, use this property to list the campaign to be evaluated by the Rule Engine. These campaigns will be evaluated, even if they are disabled, allowing you to test specific campaigns before activating them. |
[optional] |
| coupon_codes |
list[str] |
Any coupon codes entered. Important: If you create a coupon budget for your campaign, ensure the session contains a coupon code by the time you close it. |
[optional] |
| referral_code |
str |
Any referral code entered. Important: If you create a referral budget for your campaign, ensure the session contains a referral code by the time you close it. |
[optional] |
| loyalty_cards |
list[str] |
Identifier of a loyalty card. |
[optional] |
| state |
str |
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. Either: - `closed` → `cancelled` (only via Update customer session) or - `closed` → `partially_returned` (only via Return cart items) - `closed` → `open` (only via Reopen customer session) 4. `partially_returned` → `cancelled` For more information, see Customer session states. |
[default to 'open'] |
| cart_items |
list[CartItem] |
The items to add to this session. Do not exceed 1000 items and ensure the sum of all cart item's `quantity` does not exceed 10.000 per request. |
|
| additional_costs |
dict(str, AdditionalCost) |
Use this property to set a value for the additional costs of this session, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See Managing additional costs. |
[optional] |
| identifiers |
list[str] |
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. Important: Ensure the session contains an identifier by the time you close it if: - You create a unique identifier budget for your campaign. - Your campaign has coupons. |
[optional] |
| attributes |
object |
Use this property to set a value for the attributes of your choice. Attributes represent any information to attach to your session, like the shipping city. You can use built-in attributes or custom ones. Custom attributes must be created in the Campaign Manager before you set them with this property. |
|
| first_session |
bool |
Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions. |
|
| total |
float |
The total value of cart items and additional costs in the session, before any discounts are applied. |
|
| cart_item_total |
float |
The total value of cart items, before any discounts are applied. |
|
| additional_cost_total |
float |
The total value of additional costs, before any discounts are applied. |
|
| updated |
datetime |
Timestamp of the most recent event received on this session. |
|