Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.96 KB

NewCustomerSession.md

File metadata and controls

31 lines (19 loc) · 1.96 KB

NewCustomerSession

Properties

Name Type Description Notes
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`. [optional]
coupon String Any coupon code entered. [optional]
referral String Any referral code entered. [optional]
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. [optional]
cartItems List<CartItem> Serialized JSON representation. [optional]
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. [optional]
attributes Object A key-value map of the sessions attributes. The potentially valid attributes are configured in your accounts developer settings. [optional]

Enum: StateEnum

Name Value
OPEN "open"
CLOSED "closed"
PARTIALLY_RETURNED "partially_returned"
CANCELLED "cancelled"