Skip to content

Latest commit

 

History

History
533 lines (286 loc) · 19.8 KB

CustomerSessionV2.md

File metadata and controls

533 lines (286 loc) · 19.8 KB

CustomerSessionV2

Properties

Name Type Description Notes
Id Pointer to int32 Internal ID of this entity.
Created Pointer to time.Time The time this entity was created. The time this entity was created.
IntegrationId Pointer to string The integration ID set by your integration layer.
ApplicationId Pointer to int32 The ID of the application that owns this entity.
ProfileId Pointer to 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`.
StoreIntegrationId Pointer to string The integration ID of the store. You choose this ID when you create a store. [optional]
EvaluableCampaignIds Pointer to []int32 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]
CouponCodes Pointer to []string Any coupon codes entered. Important - for requests only: - If you create a coupon budget for your campaign, ensure the session contains a coupon code by the time you close it. - In requests where `dry=false`, providing an empty array discards any previous coupons. To avoid this, provide `"couponCodes": null` or omit the parameter entirely. [optional]
ReferralCode Pointer to string Any referral code entered. Important - for requests only: - If you create a referral budget for your campaign, ensure the session contains a referral code by the time you close it. - In requests where `dry=false`, providing an empty value discards the previous referral code. To avoid this, provide `"referralCode": null` or omit the parameter entirely. [optional]
LoyaltyCards Pointer to []string Identifier of a loyalty card. [optional]
State Pointer to string 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 STATE_OPEN]
CartItems Pointer to []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.
AdditionalCosts Pointer to map[string]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 Pointer to []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. 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 Pointer to map[string]interface{} 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.
FirstSession Pointer to bool Indicates whether this is the first session for the customer's profile. Will always be true for anonymous sessions.
Total Pointer to float32 The total value of cart items and additional costs in the session, before any discounts are applied.
CartItemTotal Pointer to float32 The total value of cart items, before any discounts are applied.
AdditionalCostTotal Pointer to float32 The total value of additional costs, before any discounts are applied.
Updated Pointer to time.Time Timestamp of the most recent event received on this session.

Methods

GetId

func (o *CustomerSessionV2) GetId() int32

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *CustomerSessionV2) GetIdOk() (int32, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasId

func (o *CustomerSessionV2) HasId() bool

HasId returns a boolean if a field has been set.

SetId

func (o *CustomerSessionV2) SetId(v int32)

SetId gets a reference to the given int32 and assigns it to the Id field.

GetCreated

func (o *CustomerSessionV2) GetCreated() time.Time

GetCreated returns the Created field if non-nil, zero value otherwise.

GetCreatedOk

func (o *CustomerSessionV2) GetCreatedOk() (time.Time, bool)

GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasCreated

func (o *CustomerSessionV2) HasCreated() bool

HasCreated returns a boolean if a field has been set.

SetCreated

func (o *CustomerSessionV2) SetCreated(v time.Time)

SetCreated gets a reference to the given time.Time and assigns it to the Created field.

GetIntegrationId

func (o *CustomerSessionV2) GetIntegrationId() string

GetIntegrationId returns the IntegrationId field if non-nil, zero value otherwise.

GetIntegrationIdOk

func (o *CustomerSessionV2) GetIntegrationIdOk() (string, bool)

GetIntegrationIdOk returns a tuple with the IntegrationId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasIntegrationId

func (o *CustomerSessionV2) HasIntegrationId() bool

HasIntegrationId returns a boolean if a field has been set.

SetIntegrationId

func (o *CustomerSessionV2) SetIntegrationId(v string)

SetIntegrationId gets a reference to the given string and assigns it to the IntegrationId field.

GetApplicationId

func (o *CustomerSessionV2) GetApplicationId() int32

GetApplicationId returns the ApplicationId field if non-nil, zero value otherwise.

GetApplicationIdOk

func (o *CustomerSessionV2) GetApplicationIdOk() (int32, bool)

GetApplicationIdOk returns a tuple with the ApplicationId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasApplicationId

func (o *CustomerSessionV2) HasApplicationId() bool

HasApplicationId returns a boolean if a field has been set.

SetApplicationId

func (o *CustomerSessionV2) SetApplicationId(v int32)

SetApplicationId gets a reference to the given int32 and assigns it to the ApplicationId field.

GetProfileId

func (o *CustomerSessionV2) GetProfileId() string

GetProfileId returns the ProfileId field if non-nil, zero value otherwise.

GetProfileIdOk

func (o *CustomerSessionV2) GetProfileIdOk() (string, bool)

GetProfileIdOk returns a tuple with the ProfileId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasProfileId

func (o *CustomerSessionV2) HasProfileId() bool

HasProfileId returns a boolean if a field has been set.

SetProfileId

func (o *CustomerSessionV2) SetProfileId(v string)

SetProfileId gets a reference to the given string and assigns it to the ProfileId field.

GetStoreIntegrationId

func (o *CustomerSessionV2) GetStoreIntegrationId() string

GetStoreIntegrationId returns the StoreIntegrationId field if non-nil, zero value otherwise.

GetStoreIntegrationIdOk

func (o *CustomerSessionV2) GetStoreIntegrationIdOk() (string, bool)

GetStoreIntegrationIdOk returns a tuple with the StoreIntegrationId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasStoreIntegrationId

func (o *CustomerSessionV2) HasStoreIntegrationId() bool

HasStoreIntegrationId returns a boolean if a field has been set.

SetStoreIntegrationId

func (o *CustomerSessionV2) SetStoreIntegrationId(v string)

SetStoreIntegrationId gets a reference to the given string and assigns it to the StoreIntegrationId field.

GetEvaluableCampaignIds

func (o *CustomerSessionV2) GetEvaluableCampaignIds() []int32

GetEvaluableCampaignIds returns the EvaluableCampaignIds field if non-nil, zero value otherwise.

GetEvaluableCampaignIdsOk

func (o *CustomerSessionV2) GetEvaluableCampaignIdsOk() ([]int32, bool)

GetEvaluableCampaignIdsOk returns a tuple with the EvaluableCampaignIds field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasEvaluableCampaignIds

func (o *CustomerSessionV2) HasEvaluableCampaignIds() bool

HasEvaluableCampaignIds returns a boolean if a field has been set.

SetEvaluableCampaignIds

func (o *CustomerSessionV2) SetEvaluableCampaignIds(v []int32)

SetEvaluableCampaignIds gets a reference to the given []int32 and assigns it to the EvaluableCampaignIds field.

GetCouponCodes

func (o *CustomerSessionV2) GetCouponCodes() []string

GetCouponCodes returns the CouponCodes field if non-nil, zero value otherwise.

GetCouponCodesOk

func (o *CustomerSessionV2) GetCouponCodesOk() ([]string, bool)

GetCouponCodesOk returns a tuple with the CouponCodes field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasCouponCodes

func (o *CustomerSessionV2) HasCouponCodes() bool

HasCouponCodes returns a boolean if a field has been set.

SetCouponCodes

func (o *CustomerSessionV2) SetCouponCodes(v []string)

SetCouponCodes gets a reference to the given []string and assigns it to the CouponCodes field.

GetReferralCode

func (o *CustomerSessionV2) GetReferralCode() string

GetReferralCode returns the ReferralCode field if non-nil, zero value otherwise.

GetReferralCodeOk

func (o *CustomerSessionV2) GetReferralCodeOk() (string, bool)

GetReferralCodeOk returns a tuple with the ReferralCode field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasReferralCode

func (o *CustomerSessionV2) HasReferralCode() bool

HasReferralCode returns a boolean if a field has been set.

SetReferralCode

func (o *CustomerSessionV2) SetReferralCode(v string)

SetReferralCode gets a reference to the given string and assigns it to the ReferralCode field.

GetLoyaltyCards

func (o *CustomerSessionV2) GetLoyaltyCards() []string

GetLoyaltyCards returns the LoyaltyCards field if non-nil, zero value otherwise.

GetLoyaltyCardsOk

func (o *CustomerSessionV2) GetLoyaltyCardsOk() ([]string, bool)

GetLoyaltyCardsOk returns a tuple with the LoyaltyCards field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasLoyaltyCards

func (o *CustomerSessionV2) HasLoyaltyCards() bool

HasLoyaltyCards returns a boolean if a field has been set.

SetLoyaltyCards

func (o *CustomerSessionV2) SetLoyaltyCards(v []string)

SetLoyaltyCards gets a reference to the given []string and assigns it to the LoyaltyCards field.

GetState

func (o *CustomerSessionV2) GetState() string

GetState returns the State field if non-nil, zero value otherwise.

GetStateOk

func (o *CustomerSessionV2) GetStateOk() (string, bool)

GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasState

func (o *CustomerSessionV2) HasState() bool

HasState returns a boolean if a field has been set.

SetState

func (o *CustomerSessionV2) SetState(v string)

SetState gets a reference to the given string and assigns it to the State field.

GetCartItems

func (o *CustomerSessionV2) GetCartItems() []CartItem

GetCartItems returns the CartItems field if non-nil, zero value otherwise.

GetCartItemsOk

func (o *CustomerSessionV2) GetCartItemsOk() ([]CartItem, bool)

GetCartItemsOk returns a tuple with the CartItems field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasCartItems

func (o *CustomerSessionV2) HasCartItems() bool

HasCartItems returns a boolean if a field has been set.

SetCartItems

func (o *CustomerSessionV2) SetCartItems(v []CartItem)

SetCartItems gets a reference to the given []CartItem and assigns it to the CartItems field.

GetAdditionalCosts

func (o *CustomerSessionV2) GetAdditionalCosts() map[string]AdditionalCost

GetAdditionalCosts returns the AdditionalCosts field if non-nil, zero value otherwise.

GetAdditionalCostsOk

func (o *CustomerSessionV2) GetAdditionalCostsOk() (map[string]AdditionalCost, bool)

GetAdditionalCostsOk returns a tuple with the AdditionalCosts field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasAdditionalCosts

func (o *CustomerSessionV2) HasAdditionalCosts() bool

HasAdditionalCosts returns a boolean if a field has been set.

SetAdditionalCosts

func (o *CustomerSessionV2) SetAdditionalCosts(v map[string]AdditionalCost)

SetAdditionalCosts gets a reference to the given map[string]AdditionalCost and assigns it to the AdditionalCosts field.

GetIdentifiers

func (o *CustomerSessionV2) GetIdentifiers() []string

GetIdentifiers returns the Identifiers field if non-nil, zero value otherwise.

GetIdentifiersOk

func (o *CustomerSessionV2) GetIdentifiersOk() ([]string, bool)

GetIdentifiersOk returns a tuple with the Identifiers field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasIdentifiers

func (o *CustomerSessionV2) HasIdentifiers() bool

HasIdentifiers returns a boolean if a field has been set.

SetIdentifiers

func (o *CustomerSessionV2) SetIdentifiers(v []string)

SetIdentifiers gets a reference to the given []string and assigns it to the Identifiers field.

GetAttributes

func (o *CustomerSessionV2) GetAttributes() map[string]interface{}

GetAttributes returns the Attributes field if non-nil, zero value otherwise.

GetAttributesOk

func (o *CustomerSessionV2) GetAttributesOk() (map[string]interface{}, bool)

GetAttributesOk returns a tuple with the Attributes field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasAttributes

func (o *CustomerSessionV2) HasAttributes() bool

HasAttributes returns a boolean if a field has been set.

SetAttributes

func (o *CustomerSessionV2) SetAttributes(v map[string]interface{})

SetAttributes gets a reference to the given map[string]interface{} and assigns it to the Attributes field.

GetFirstSession

func (o *CustomerSessionV2) GetFirstSession() bool

GetFirstSession returns the FirstSession field if non-nil, zero value otherwise.

GetFirstSessionOk

func (o *CustomerSessionV2) GetFirstSessionOk() (bool, bool)

GetFirstSessionOk returns a tuple with the FirstSession field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasFirstSession

func (o *CustomerSessionV2) HasFirstSession() bool

HasFirstSession returns a boolean if a field has been set.

SetFirstSession

func (o *CustomerSessionV2) SetFirstSession(v bool)

SetFirstSession gets a reference to the given bool and assigns it to the FirstSession field.

GetTotal

func (o *CustomerSessionV2) GetTotal() float32

GetTotal returns the Total field if non-nil, zero value otherwise.

GetTotalOk

func (o *CustomerSessionV2) GetTotalOk() (float32, bool)

GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasTotal

func (o *CustomerSessionV2) HasTotal() bool

HasTotal returns a boolean if a field has been set.

SetTotal

func (o *CustomerSessionV2) SetTotal(v float32)

SetTotal gets a reference to the given float32 and assigns it to the Total field.

GetCartItemTotal

func (o *CustomerSessionV2) GetCartItemTotal() float32

GetCartItemTotal returns the CartItemTotal field if non-nil, zero value otherwise.

GetCartItemTotalOk

func (o *CustomerSessionV2) GetCartItemTotalOk() (float32, bool)

GetCartItemTotalOk returns a tuple with the CartItemTotal field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasCartItemTotal

func (o *CustomerSessionV2) HasCartItemTotal() bool

HasCartItemTotal returns a boolean if a field has been set.

SetCartItemTotal

func (o *CustomerSessionV2) SetCartItemTotal(v float32)

SetCartItemTotal gets a reference to the given float32 and assigns it to the CartItemTotal field.

GetAdditionalCostTotal

func (o *CustomerSessionV2) GetAdditionalCostTotal() float32

GetAdditionalCostTotal returns the AdditionalCostTotal field if non-nil, zero value otherwise.

GetAdditionalCostTotalOk

func (o *CustomerSessionV2) GetAdditionalCostTotalOk() (float32, bool)

GetAdditionalCostTotalOk returns a tuple with the AdditionalCostTotal field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasAdditionalCostTotal

func (o *CustomerSessionV2) HasAdditionalCostTotal() bool

HasAdditionalCostTotal returns a boolean if a field has been set.

SetAdditionalCostTotal

func (o *CustomerSessionV2) SetAdditionalCostTotal(v float32)

SetAdditionalCostTotal gets a reference to the given float32 and assigns it to the AdditionalCostTotal field.

GetUpdated

func (o *CustomerSessionV2) GetUpdated() time.Time

GetUpdated returns the Updated field if non-nil, zero value otherwise.

GetUpdatedOk

func (o *CustomerSessionV2) GetUpdatedOk() (time.Time, bool)

GetUpdatedOk returns a tuple with the Updated field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

HasUpdated

func (o *CustomerSessionV2) HasUpdated() bool

HasUpdated returns a boolean if a field has been set.

SetUpdated

func (o *CustomerSessionV2) SetUpdated(v time.Time)

SetUpdated gets a reference to the given time.Time and assigns it to the Updated field.

[Back to Model list] [Back to API list] [Back to README]