BasketManager

This class manipulates the baskets in eCommerce.

Namespace

Ektron.Cms.Framework.Commerce.BasketManager

Constructors

  • BasketManager()
  • BasketManager(ApiAccessMode)

Properties

  • ApiMode. Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
  • ApplicationPath. Gets the application path to the Workarea.
  • ContentLanguage. Gets or sets the current content language.
  • InPreviewMode. Gets or sets the preview mode and returns true if the site is in preview mode.
  • IsCommerceEnabled. Checks for a commerce license.
  • RequestInformation. Gets information about the current request.
  • SitePath. Gets the site path.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.Commerce.BasketData)

Adds the new basket to the specific user in CMS. The basketData.Id is populated with the Id of the new basket.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * User ID
  • Shopper ID

Parameters

  • basketData. Basket object to be added.

Returns

Returns the added BasketData object.

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxBasketNameLabel" AssociatedControlID="uxBasketName" CssClass="span-3 last" runat="server" Text="* Name:" />
        <ektronUI:TextField  ID="uxBasketName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxBasketUserIdLabel" AssociatedControlID="uxBasketUserId" CssClass="span-3 last" runat="server" Text=" User Id:" />
        <ektronUI:TextField  ID="uxBasketUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
     <li class="clearfix">
        <ektronUI:Label ID="uxBasketShopperIdLabel" AssociatedControlID="uxBasketShopperId" CssClass="span-3 last" runat="server" Text=" Shopper Id:" />
        <ektronUI:TextField  ID="uxBasketShopperId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>        
    <li class="clearfix">
        <ektronUI:Label ID="uxBasketDefaultLabel" AssociatedControlID="uxBasketDefault" CssClass="span-3 last" runat="server" Text=" IsDefault:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxBasketDefault" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>      
     <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.BasketManager basketManager = new Ektron.Cms.Framework.Commerce.BasketManager();
            bool isDefault = false;
            if (uxBasketDefault.Checked)
            {
                isDefault = true;
            }
            BasketData basketData = new BasketData()
            {
                Name = uxBasketName.Text,
                UserId = long.Parse(uxBasketUserId.Text),
                ShopperId = uxBasketShopperId.Text,
                IsDefault = isDefault
            };
            BasketData newBasketData = basketManager.Add(basketData);
                        
            if (newBasketData.Id > 0)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Basket is added with Id " + newBasketData.Id, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Basket adding process is failed", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

ApplyCoupon

ApplyCoupon(System.Int64,System.Int64)

Apply the coupon to the basket.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Basket ID
  • * Coupon ID

Parameters

  • basketId. ID of the basket.
  • couponId. ID of the coupon to be applied to the basket.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxBasketIdLabel" AssociatedControlID="uxBasketId" CssClass="span-3 last" runat="server" Text="* Basket Id:" />
        <ektronUI:TextField  ID="uxBasketId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li> 
    <li class="clearfix">
        <ektronUI:Label ID="uxCouponIdLabel" AssociatedControlID="uxCouponId" CssClass="span-3 last" runat="server" Text="* Coupon Id:" />
        <ektronUI:TextField  ID="uxCouponId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>      
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Apply Coupon"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.BasketManager basketManager = new Ektron.Cms.Framework.Commerce.BasketManager();
            CouponManager couponManager = new CouponManager();
            long couponId=long.Parse(uxCouponId.Text);
            long basketId= long.Parse(uxBasketId.Text);
			CouponData couponData = couponManager.GetItem(couponId);
            BasketData basketData = basketManager.GetItem(basketId);
            
            if (couponData != null && basketData!=null)
            {
                basketManager.ApplyCoupon(basketId, couponId);
                MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " applied to the basket " + basketId, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Invalid Coupon or Basket Id." , Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

Delete

Delete(System.Int64)

Deletes a basket from the CMS by its ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Basket ID

Parameters

  • basketId. ID of basket to be deleted.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxBasketIdLabel" AssociatedControlID="uxBasketId" CssClass="span-4 last" runat="server" Text="* Basket Id:" />
        <ektronUI:TextField ID="uxBasketId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>        
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long ID = long.Parse(uxBasketId.Text);
            Ektron.Cms.Framework.Commerce.BasketManager basketManager = new Ektron.Cms.Framework.Commerce.BasketManager();
            basketManager.Delete(ID);
            MessageUtilities.UpdateMessage(uxMessage, "BasketData with Id " + uxBasketId.Text + " is deleted", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Empty

Empty(System.Int64)

Deletes all the items in a basket by it's basket ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Basket ID

Parameters

  • basketId. ID of basket to be deleted.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxBasketIdLabel" AssociatedControlID="uxBasketId" CssClass="span-4 last" runat="server" Text="* Basket Id:" />
        <ektronUI:TextField ID="uxBasketId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Empty"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>        
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long basketId = long.Parse(uxBasketId.Text);
            Ektron.Cms.Framework.Commerce.BasketManager basketManager = new Ektron.Cms.Framework.Commerce.BasketManager();
            basketManager.Empty(basketId);
            MessageUtilities.UpdateMessage(uxMessage, "Basket items are deleted", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetAppliedCoupons

GetAppliedCoupons(System.Int64)

Retrieves the list of coupon items which are applied to the basket.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Basket ID

Parameters

  • basketId. ID of basket.

Returns

List of coupons.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxBasketIdLabel" AssociatedControlID="uxBasketId" CssClass="span-4 last" runat="server" Text="* Basket Id:" />
        <ektronUI:TextField ID="uxBasketId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetAppliedCoupons"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
 
<asp:ListView ID="uxCouponListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                       Id
                    </th>
                    <th>
                        Code
                    </th>
                    <th>
                        IsActive
                    </th>
                    <th>
                        CurrencyId
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Code")%>
            </td>
            <td class="devsite-method">
                <%# Eval("IsActive")%>
            </td>
            <td class="devsite-method">
                <%# Eval("CurrencyId")%>
            </td>
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.BasketManager basketManager = new Ektron.Cms.Framework.Commerce.BasketManager();
            long basketId = long.Parse(uxBasketId.Text);
            List<CouponData> listCouponData = basketManager.GetAppliedCoupons(basketId);

            uxCouponListView.Visible = true;
            uxCouponListView.DataSource = listCouponData;
            uxCouponListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

GetDefault (default)

GetDefault()

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Returns

The default basket object.

.aspx code snippet

<ol class="formFields">
   <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetDefault"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsDefault" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxSubtotal" runat="server"></asp:Literal>
    </li>              
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            Ektron.Cms.Framework.Commerce.BasketManager basketManager = new Ektron.Cms.Framework.Commerce.BasketManager();
            BasketData basketData = new BasketData();
            basketData = basketManager.GetDefault();
            if (basketData != null)
            {

                MessageUtilities.UpdateMessage(uxMessage, "Details for default basket data are below", Message.DisplayModes.Success);
                uxName.Text = "Name : " + basketData.Name;
                uxUserId.Text = "UserId : " + basketData.UserId;
                uxIsDefault.Text = "IsDefault : " + basketData.IsDefault;
                uxSubtotal.Text = "Subtotal : " + basketData.Subtotal;

            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Default basket data does not exist ", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetDefault (shopper)

GetDefault(System.String)

Gets a default basket for a non-logged in user based upon the shopper's GUID string.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Shopper ID

Parameters

  • shopperId. The ID of the non-logged in shopper.

Returns

Returns the default basket object of the shopper.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxShopperIdLabel" AssociatedControlID="uxShopperId" CssClass="span-3 last" runat="server" Text="* Shopper Id:" />
        <ektronUI:TextField ID="uxShopperId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="" />
    </li>  
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetDefault"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxuserIdres" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsDefault" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxSubtotal" runat="server"></asp:Literal>
    </li>              
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            string shopperId = uxShopperId.Text;

            Ektron.Cms.Framework.Commerce.BasketManager basketManager = new Ektron.Cms.Framework.Commerce.BasketManager();
            BasketData basketData = new BasketData();
            basketData = basketManager.GetDefault(shopperId);
            if (basketData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for visitor basket with shopperId " + basketData.ShopperId.ToString() + " are below", Message.DisplayModes.Success);
                uxuserIdres.Text = "Id : " + basketData.Id;
                uxName.Text = "Name : " + basketData.Name;
                uxIsDefault.Text = "IsDefault : " + basketData.IsDefault;
                uxSubtotal.Text = "Subtotal : " + basketData.Subtotal;

            }
            else
            {

                MessageUtilities.UpdateMessage(uxMessage, "Either visitor or basket data with shopper ID " + shopperId + " does not exist ", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetDefault (user)

GetDefault(System.Int64)

Gets the default basket of the specific user.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * User ID

Parameters

  • userId. The ID of the user.

Returns

Returns the default basket object of the user.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-3 last" runat="server" Text="* User Id:" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>  
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetDefault"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxuserIdres" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsDefault" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxSubtotal" runat="server"></asp:Literal>
    </li>              
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long userId = long.Parse(uxUserId.Text);

            Ektron.Cms.Framework.Commerce.BasketManager basketManager = new Ektron.Cms.Framework.Commerce.BasketManager();
            BasketData basketData = new BasketData();
            basketData = basketManager.GetDefault(userId);
            if (basketData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for user basket with userId " + basketData.UserId.ToString() + " are below", Message.DisplayModes.Success);
                uxuserIdres.Text = "Id : " + basketData.Id;
                uxName.Text = "Name : " + basketData.Name;
                uxIsDefault.Text = "IsDefault : " + basketData.IsDefault;
                uxSubtotal.Text = "Subtotal : " + basketData.Subtotal;

            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Either user or basket data with user ID " + userId + " does not exist ", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(System.Int64)

Retrieves a single basket by its ID.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Basket ID

Parameters

  • basketId. ID of basket to be retrieved.

Returns

Returns the basket that matches the ID.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxBasketIdLabel" AssociatedControlID="uxBasketId" CssClass="span-3 last" runat="server" Text="* Basket Id:" />
        <ektronUI:TextField ID="uxBasketId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>  
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetItem"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsDefault" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxSubtotal" runat="server"></asp:Literal>
    </li>              
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long basketId = long.Parse(uxBasketId.Text);

            Ektron.Cms.Framework.Commerce.BasketManager basketManager = new Ektron.Cms.Framework.Commerce.BasketManager();
            BasketData basketData = new BasketData();
            basketData = basketManager.GetItem(basketId);
            if (basketData != null)
            {

                MessageUtilities.UpdateMessage(uxMessage, "Details for basket  Id " + basketData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxName.Text = "Name : " + basketData.Name;
                uxUserId.Text = "UserId : " + basketData.UserId;
                uxIsDefault.Text = "IsDefault : " + basketData.IsDefault;
                uxSubtotal.Text = "Subtotal : " + basketData.Subtotal;

            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Either basket data with ID " + basketId + " does not exist ", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(System.Int64)

Retrieves a list of saved baskets of a user.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * User ID

Parameters

  • userId. ID of the user.

Returns

Returns a list of saved basket objects of the user.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-5 last" runat="server" Text="* User Id:" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-5" runat="server" Text="* - Required" /> 
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>            
<asp:ListView ID="uxBasketDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >No records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                 <tr>
                    <th>Id</th>
                    <th>Name</th>
                    <th>UserId</th>
                    <th>IsDefault</th>
                    <th>Subtotal</th>
                 </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
                <td class="devsite-method">
                <%# Eval("Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("IsDefault")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Subtotal")%>
            </td>
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Common;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long userId = long.Parse(uxUserId.Text);

            Ektron.Cms.Framework.Commerce.BasketManager basketManager = new Ektron.Cms.Framework.Commerce.BasketManager();
            List<BasketData> basketDataList = basketManager.GetList(userId);
            uxBasketDataListView.Visible = true;
            uxBasketDataListView.DataSource = basketDataList;
            uxBasketDataListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

RemoveCoupon

RemoveCoupon(System.Int64,System.Int64)

Removes the coupon from the basket.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Basket ID
  • * Coupon ID

Parameters

  • basketId. ID of the basket from which the coupon is removed.
  • couponId. ID of the coupon to be removed from basket.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxBasketIdLabel" AssociatedControlID="uxBasketId" CssClass="span-3 last" runat="server" Text="* Basket Id:" />
        <ektronUI:TextField  ID="uxBasketId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li> 
    <li class="clearfix">
        <ektronUI:Label ID="uxCouponIdLabel" AssociatedControlID="uxCouponId" CssClass="span-3 last" runat="server" Text="* Coupon Id:" />
        <ektronUI:TextField  ID="uxCouponId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>        
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="RemoveCoupon"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.BasketManager basketManager = new Ektron.Cms.Framework.Commerce.BasketManager();
            long couponId = long.Parse(uxCouponId.Text);
            long basketId = long.Parse(uxBasketId.Text);

            basketManager.RemoveCoupon(basketId, couponId);
                        
            MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is removed from basket "+ basketId , Message.DisplayModes.Success);
                        
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

SetDefault

SetDefault(System.Int64,System.Int64)

Sets the basket as default basket to the user.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Basket ID
  • * User ID

Parameters

  • basketId. ID of the basket from which the coupon is removed.
  • userId. ID of the user.

.aspx code snippet

<ol class="formFields">
   <li class="clearfix">
        <ektronUI:Label ID="uxBasketIdLabel" AssociatedControlID="uxBasketId" CssClass="span-5 last" runat="server" Text="* Basket Id:" />
        <ektronUI:TextField ID="uxBasketId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-5 last" runat="server" Text="* User Id:" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>        
    <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="SetDefault"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-5" runat="server" Text="* - Required" />
    </li>
</ol>    
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            Ektron.Cms.Framework.Commerce.BasketManager basketManager = new Ektron.Cms.Framework.Commerce.BasketManager();
            long basketId = long.Parse(uxBasketId.Text);
            long userId = long.Parse(uxUserId.Text);

            BasketData basket = basketManager.GetItem(basketId);
            if (basket != null)
            {
                basketManager.SetDefault(basketId, userId);
                MessageUtilities.UpdateMessage(uxMessage, "Basket " + basketId + " is maked as default basket to the user " + userId, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Basket Id is not valid. ", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update

Update(Ektron.Cms.Commerce.BasketData)

Updates the existing basket in the CMS.

Authenticated users

  • CMS Administrators
  • Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Basket ID
  • Name
  • Is Default

Parameters

  • basketData. Basket object to be updated.

Returns

Returns the updated BasketData object.

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxBasketIdLabel" AssociatedControlID="uxBasketId" CssClass="span-3 last" runat="server" Text="* Basket Id:" />
        <ektronUI:TextField  ID="uxBasketId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
     <li class="clearfix">
        <ektronUI:Label ID="uxBasketNameLabel" AssociatedControlID="uxBasketName" CssClass="span-3 last" runat="server" Text=" Name:" />
        <ektronUI:TextField  ID="uxBasketName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>    
    <li class="clearfix">
        <ektronUI:Label ID="uxBasketDefaultLabel" AssociatedControlID="uxBasketDefault" CssClass="span-3 last" runat="server" Text=" IsDefault:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxBasketDefault" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>      
     <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Commerce;
using Ektron.Cms.Framework.Commerce;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            Ektron.Cms.Framework.Commerce.BasketManager basketManager = new Ektron.Cms.Framework.Commerce.BasketManager();
            bool isDefault = false;
            if (uxBasketDefault.Checked)
            {
                isDefault = true;
            }
            BasketData basketData = basketManager.GetItem(long.Parse(uxBasketId.Text));
            if (basketData != null)
            {
                basketData.Name = uxBasketName.Text;
                basketData.IsDefault = isDefault;
                basketManager.Update(basketData);
                MessageUtilities.UpdateMessage(uxMessage, "Basket is updated with Id " + basketData.Id, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Basket id " + uxBasketId.Text + " does not exists", Message.DisplayModes.Success);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

        }        
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

Data Classes

BasketData

Namespace

Ektron.Cms.Commerce

Properties

  • BasketData()
    public BasketData()
  • DateCreated. Gets or sets the date created.
     public System.DateTime DateCreated { set; get; }
  • DateModified. Gets or sets the date modified.
     public System.DateTime DateModified { set; get; }
  • HasRecurringItems
     public bool HasRecurringItems { get; }
  • HasSubscriptions
     public bool HasSubscriptionItems { get; }
  • HasTangibleItems
     public bool HasTangibleItems { get; }
  • Id. Gets or sets the Id of the Basket.
    public long Id { set; get; }
  • IsDefault. Gets or sets value indicating whether or not this basket is the default basket for customers.
     public bool IsDefault { set; get; }
  • Items. Gets the collection items in the basket.
     public Ektron.Cms.Commerce.BasketItemCollection Items { set; get; }
  • Name. Gets or sets the name of the basket.
     public string Name { set; get; }
  • ShippingAddressId. Gets or sets the ID of the address this basket will be shipping to. This is used for calculating taxes, shipping, and so on.
     public long ShippingAddressId { set; get; }
  • ShippingMethodId. Gets or sets the ID of the shipping method to be used for the basket. This is used for calculating shipping costs.
     public long ShippingMethodId { set; get; }
  • ShopperId. Gets or sets the Shopper\visitor Id using the basket. This Id is used when customer is not logged in.
     public string ShopperId { set; get; }
  • Subtotal. Gets the basket subtotal.
     public decimal Subtotal { get; }
  • UserId. Gets or sets the Id of the user asscoiated with the basket.
     public long UserId { set; get; }