CustomerManager

The class manipulates e-commerce customer details in CMS.

Namespace

Ektron.Cms.Framework.Commerce.CustomerManager

Constructors

  • CustomerManager()
  • CustomerManager(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 (billing address)

Add(Ektron.Cms.Commerce.CustomerData,Ektron.Cms.Commerce.AddressData)

Adds a new customer with a billing address. The Customer.Id property is populated with the new Customer's 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

  • * User Name
  • * Password
  • * Display Name
  • First Name
  • Last Name
  • Email

Billing Address

  • * Address Name
  • * Address Line 1
  • * City
  • * Region ID
  • * Postal Code
  • * Country ID

Parameters

  • customerData. Customer data to be added.
  • billingAddress. Billing address of the customer. Also serves as shipping address.

Returns

Returns customer data with new customer's ID.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserNameLabel" AssociatedControlID="uxUserName" CssClass="span-3 last"
            runat="server" Text="* UserName :" />
        <ektronUI:TextField ID="uxUserName" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>                    
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordLabel" AssociatedControlID="uxPassword" CssClass="span-3 last"
            runat="server" Text="* Password :" />
        <asp:TextBox ID="uxPassword" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            TextMode="Password" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDisplayLabel" AssociatedControlID="uxDisplay" CssClass="span-3 last"
            runat="server" Text="* DisplayName :" />
        <ektronUI:TextField ID="uxDisplay" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFirstNameLabel" AssociatedControlID="uxFirstName" CssClass="span-3 last"
            runat="server" Text="FirstName :" />
        <ektronUI:TextField ID="uxFirstName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLastNameLabel" AssociatedControlID="uxLastName" CssClass="span-3 last"
            runat="server" Text="LastName :" />
        <ektronUI:TextField ID="uxLastName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxEmailLabel" AssociatedControlID="uxEmail" CssClass="span-3 last"
            runat="server" Text="Email :" />
        <ektronUI:TextField ID="uxEmail" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <b>Billing Address</b>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressNameLabel" AssociatedControlID="uxAddressName" CssClass="span-3 last"
            runat="server" Text="* AddressName :" />
        <ektronUI:TextField ID="uxAddressName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressLine1Label" AssociatedControlID="uxAddressLine1" CssClass="span-3 last"
            runat="server" Text="* AddressLine1 :" />
        <ektronUI:TextField ID="uxAddressLine1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCityLabel" AssociatedControlID="uxCity" CssClass="span-3 last"
            runat="server" Text="* City :" />
        <ektronUI:TextField ID="uxCity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxRegionIdLagel" AssociatedControlID="uxRegionId" CssClass="span-3 last"
            runat="server" Text="* RegionId :" />
        <ektronUI:TextField ID="uxRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPostalCodeLabel" AssociatedControlID="uxPostalCode" CssClass="span-3 last"
            runat="server" Text="* PostalCode :" />
        <ektronUI:TextField ID="uxPostalCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCountryIdLabel" AssociatedControlID="uxCountryId" CssClass="span-3 last"
            runat="server" Text="* CountryId :" />
        <ektronUI:TextField ID="uxCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>                    
    <li class="clearfix" style="color: red;">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            string password = uxPassword.Text;
            string display = uxDisplay.Text;
            long regionId;
            long.TryParse(uxRegionId.Text, out regionId);
            int countryId;
            int.TryParse(uxCountryId.Text, out countryId);
            string emailAddress = uxEmail.Text;
            if (!string.IsNullOrEmpty(emailAddress))
            {
                try
                {
                    System.Net.Mail.MailAddress addr = new System.Net.Mail.MailAddress(emailAddress);
                }
                catch
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Email Address.", Message.DisplayModes.Error);
                    return;
                }
            }

            if (password != "" && display != "" && regionId > 0 && countryId > 0)
            {
                CustomerManager customerManager = new CustomerManager();

                //Customer Information
                CustomerData customerData = new CustomerData();
                customerData.UserName = uxUserName.Text; ;
                customerData.Password = password;
                customerData.FirstName = uxFirstName.Text;
                customerData.LastName = uxLastName.Text;
                customerData.EmailAddress = emailAddress;
                customerData.DisplayName = display;
                customerData.IsMembershipUser = true;
                //BillingAddress Information
                AddressData billingAddress = new AddressData();
                billingAddress.Name = uxAddressName.Text;
                billingAddress.AddressLine1 = uxAddressLine1.Text;
                billingAddress.City = uxCity.Text;
                billingAddress.Region = new RegionData { Id = regionId };
                billingAddress.PostalCode = uxPostalCode.Text;
                billingAddress.Country = new CountryData { Id = countryId };

                long customerId = customerManager.Add(customerData, billingAddress).Id;
                MessageUtilities.UpdateMessage(uxMessage, "Customer Added with Id: " + customerId.ToString(), Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid values for required fields", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Add (customer ID)

Add(Ektron.Cms.Commerce.CustomerData)

Adds a new customer. The Customer.Id property is populated with the new Customer's 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

  • * User Name
  • * Password
  • * Display Name
  • First Name
  • Last Name
  • Email

Parameters

  • customerData. Customer data to be added.

Returns

Returns customer data with new customer's ID.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserNameLabel" AssociatedControlID="uxUserName" CssClass="span-3 last"
            runat="server" Text="* UserName :" />
        <ektronUI:TextField ID="uxUserName" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li> 
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordLabel" AssociatedControlID="uxPassword" CssClass="span-3 last"
            runat="server" Text="* Password :" />
        <asp:TextBox ID="uxPassword" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            TextMode="Password" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDisplayLabel" AssociatedControlID="uxDisplay" CssClass="span-3 last"
            runat="server" Text="* DisplayName :" />
        <ektronUI:TextField ID="uxDisplay" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFirstNameLabel" AssociatedControlID="uxFirstName" CssClass="span-3 last"
            runat="server" Text="FirstName :" />
        <ektronUI:TextField ID="uxFirstName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLastNameLabel" AssociatedControlID="uxLastName" CssClass="span-3 last"
            runat="server" Text="LastName :" />
        <ektronUI:TextField ID="uxLastName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
 
    <li class="clearfix">
        <ektronUI:Label ID="uxEmailLabel" AssociatedControlID="uxEmail" CssClass="span-3 last"
            runat="server" Text="Email :" />
        <ektronUI:TextField ID="uxEmail" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix" style="color: red;">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {            
            string password = uxPassword.Text;
            string display = uxDisplay.Text;
            string emailAddress = uxEmail.Text;            
            if (!string.IsNullOrEmpty(emailAddress))
            {
                try
                {
                    System.Net.Mail.MailAddress addr = new System.Net.Mail.MailAddress(emailAddress);
                }
                catch
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Email Address.", Message.DisplayModes.Error);
                    return;
                }
            }

            if (password != "" && display != "")
            {
                CustomerManager customerManager = new CustomerManager();
                CustomerData customerData = new CustomerData();
                customerData.UserName = uxUserName.Text;
                customerData.Password = password;
                customerData.FirstName = uxFirstName.Text;
                customerData.LastName = uxLastName.Text;
                customerData.EmailAddress = emailAddress;
                customerData.DisplayName = display;
                customerData.IsMembershipUser = true;
                long customerId = customerManager.Add(customerData).Id;
                MessageUtilities.UpdateMessage(uxMessage, "Customer Added with Id: " + customerId.ToString(), Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid values for required fields", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Add (shipping address)

Add(Ektron.Cms.Commerce.CustomerData,Ektron.Cms.Commerce.AddressData,Ektron.Cms.Commerce.AddressData)

Adds a new customer with separate billing and shipping addresses. The Customer.Id property is populated with the new Customer's 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

  • * User Name
  • * Password
  • * Display Name
  • First Name
  • Last Name
  • Email

Billing Address

  • * Address Name
  • * Address Line 1
  • * City
  • * Region ID
  • * Postal Code
  • * Country ID

Shipping Address

  • * Address Name
  • * Address Line 1
  • * City
  • * Region ID
  • * Postal Code
  • * Country ID

Parameters

  • customerData. Customer data to be added.
  • billingAddress. Billing address of the customer.
  • shippingAddress. Shipping address of the customer.

Returns

Returns customer data with new customer's ID.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserNameLabel" AssociatedControlID="uxUserName" CssClass="span-3 last"
            runat="server" Text="* UserName :" />
        <ektronUI:TextField ID="uxUserName" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>                    
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordLabel" AssociatedControlID="uxPassword" CssClass="span-3 last"
            runat="server" Text="* Password :" />
        <asp:TextBox ID="uxPassword" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            TextMode="Password" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDisplayLabel" AssociatedControlID="uxDisplay" CssClass="span-3 last"
            runat="server" Text="* DisplayName :" />
        <ektronUI:TextField ID="uxDisplay" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFirstNameLabel" AssociatedControlID="uxFirstName" CssClass="span-3 last"
            runat="server" Text="FirstName :" />
        <ektronUI:TextField ID="uxFirstName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLastNameLabel" AssociatedControlID="uxLastName" CssClass="span-3 last"
            runat="server" Text="LastName :" />
        <ektronUI:TextField ID="uxLastName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxEmailLabel" AssociatedControlID="uxEmail" CssClass="span-3 last"
            runat="server" Text="Email :" />
        <ektronUI:TextField ID="uxEmail" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <b>Billing Address</b>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxBillingAddressNameLabel" AssociatedControlID="uxBillingAddressName" CssClass="span-3 last"
            runat="server" Text="* AddressName :" />
        <ektronUI:TextField ID="uxBillingAddressName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxBillingAddressLine1Label" AssociatedControlID="uxBillingAddressLine1" CssClass="span-3 last"
            runat="server" Text="* AddressLine1 :" />
        <ektronUI:TextField ID="uxBillingAddressLine1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxBillingCityLabel" AssociatedControlID="uxBillingCity" CssClass="span-3 last"
            runat="server" Text="* City :" />
        <ektronUI:TextField ID="uxBillingCity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxBillingRegionIdLagel" AssociatedControlID="uxBillingRegionId" CssClass="span-3 last"
            runat="server" Text="* RegionId :" />
        <ektronUI:TextField ID="uxBillingRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxBillingPostalCodeLabel" AssociatedControlID="uxBillingPostalCode" CssClass="span-3 last"
            runat="server" Text="* PostalCode :" />
        <ektronUI:TextField ID="uxBillingPostalCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxBillingCountryIdLabel" AssociatedControlID="uxBillingCountryId" CssClass="span-3 last"
            runat="server" Text="* CountryId :" />
        <ektronUI:TextField ID="uxBillingCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <b>Shipping Address</b>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingAddressNameLabel" AssociatedControlID="uxShippingAddressName" CssClass="span-3 last"
            runat="server" Text="* AddressName :" />
        <ektronUI:TextField ID="uxShippingAddressName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingAddressLine1Label" AssociatedControlID="uxShippingAddressLine1" CssClass="span-3 last"
            runat="server" Text="* AddressLine1 :" />
        <ektronUI:TextField ID="uxShippingAddressLine1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingCityLabel" AssociatedControlID="uxShippingCity" CssClass="span-3 last"
            runat="server" Text="* City :" />
        <ektronUI:TextField ID="uxShippingCity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingRegionIdLabel" AssociatedControlID="uxShippingRegionId" CssClass="span-3 last"
            runat="server" Text="* RegionId :" />
        <ektronUI:TextField ID="uxShippingRegionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingPostalCodeLabel" AssociatedControlID="uxShippingPostalCode" CssClass="span-3 last"
            runat="server" Text="* PostalCode :" />
        <ektronUI:TextField ID="uxShippingPostalCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingCountryIdLabel" AssociatedControlID="uxShippingCountryId" CssClass="span-3 last"
            runat="server" Text="* CountryId :" />
        <ektronUI:TextField ID="uxShippingCountryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>  
    <li class="clearfix" style="color: red;">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            string password = uxPassword.Text;
            string display = uxDisplay.Text;
            long regionId;
            long.TryParse(uxRegionId.Text, out regionId);
            int countryId;
            int.TryParse(uxCountryId.Text, out countryId);
            string emailAddress = uxEmail.Text;
            if (!string.IsNullOrEmpty(emailAddress))
            {
                try
                {
                    System.Net.Mail.MailAddress addr = new System.Net.Mail.MailAddress(emailAddress);
                }
                catch
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Email Address.", Message.DisplayModes.Error);
                    return;
                }
            }

            if (password != "" && display != "" && regionId > 0 && countryId > 0)
            {
                CustomerManager customerManager = new CustomerManager();

                //Customer Information
                CustomerData customerData = new CustomerData();
                customerData.UserName = uxUserName.Text; ;
                customerData.Password = password;
                customerData.FirstName = uxFirstName.Text;
                customerData.LastName = uxLastName.Text;
                customerData.EmailAddress = emailAddress;
                customerData.DisplayName = display;
                customerData.IsMembershipUser = true;
                //BillingAddress Information
                AddressData billingAddress = new AddressData();
                billingAddress.Name = uxAddressName.Text;
                billingAddress.AddressLine1 = uxAddressLine1.Text;
                billingAddress.City = uxCity.Text;
                billingAddress.Region = new RegionData { Id = regionId };
                billingAddress.PostalCode = uxPostalCode.Text;
                billingAddress.Country = new CountryData { Id = countryId };

                long customerId = customerManager.Add(customerData, billingAddress).Id;
                MessageUtilities.UpdateMessage(uxMessage, "Customer Added with Id: " + customerId.ToString(), Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid values for required fields", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete

Delete(System.Int64)

Deletes a customer from 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

  • * Customer ID

Parameters

  • customerId. ID of the customer to be deleted.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCustomerIdLabel" AssociatedControlID="uxCustomerId" CssClass="span-3 last"
            runat="server" Text="* CustomerId :" />
        <ektronUI:TextField ID="uxCustomerId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </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 System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            CustomerManager customerManager = new CustomerManager();
            long customerId;
            long.TryParse(uxCustomerId.Text, out customerId);
            if (customerId > 0)
            {
                CustomerData customerData = customerManager.GetItem(customerId);
                if (customerData != null)
                {
                    customerManager.Delete(customerId);
                    MessageUtilities.UpdateMessage(uxMessage, "Customer with Id " + customerId.ToString() + " has been Deleted.", Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Customer Id", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Customer Id", 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 customer.

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

  • * Customer ID

Parameters

  • customerId. ID of the customer to be retrieved.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCustomerIdLabel" AssociatedControlID="uxCustomerId" CssClass="span-3 last"
            runat="server" Text="* CustomerId :" />
        <ektronUI:TextField ID="uxCustomerId" CssClass="span-4" 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-4" runat="server" Text="* - Required" />
    </li>
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFirstName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxLastName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDisplayName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxEmail" 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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            CustomerManager customerManager = new CustomerManager();
            long customerId;
            long.TryParse(uxCustomerId.Text, out customerId);
            if (customerId > 0)
            {
                CustomerData customerData = customerManager.GetItem(customerId);
                if (customerData != null)
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Customer Details for  Customer Id : " + customerId.ToString() + " are below", Message.DisplayModes.Success);
                    uxUserName.Text = "UserName : " + customerData.UserName;
                    uxFirstName.Text = "FirstName : " + customerData.FirstName;
                    uxLastName.Text = "LastName : " + customerData.LastName;
                    uxDisplayName.Text = "DisplayName : " + customerData.DisplayName;
                    uxEmail.Text = "Email : " + customerData.EmailAddress;
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Customer Id", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Customer Id", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(Ektron.Cms.Commerce.CustomerCriteria)

Returns a list of customers based upon supplied criteria.

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

  • * Customer Property
  • * Object Value

Parameters

  • criteria. Criteria by which to retrieve customer objects.

Returns

List of CustomerData.

Criteria use

The DataProperty enum works with its criteria class and defines the properties that the Manager class uses to filter and order. Specify zero (0) or more criteria to retrieve the objects you want. The criteria object also lets you set the number of items to return, define paging data, and modify sorting.

Criteria objects
  • Condition. The Logical operator to apply to the filters. The default value is "AND". The criteria condition controls the operator for the default filter group and the AND-ing\Or-ing the filter groups together.
    public Ektron.Cms.Common.LogicalOperation Condition { set; get; }
  • FilterGroups. Gets a list of filter groups. Filter groups can be created to do filter grouping (that is, parentheses in the where clause). The groups use the criteria's condition like other filters, but can use their own condition internally.
    public 
  System.Collections.Generic.List<CriteriaFilterGroup<ActivityCommentProperty>> 
  FilterGroups { get; }
  • Filters. Lists of filters defined in this criteria object. To add new Filters, you can add them here or use the AddFilter method (recommended).
    public 
  System.Collections.Generic.List<CriteriaFilter<ActivityCommentProperty>> 
  Filters { get; }
  • GroupByField. The group by field to apply to the results.
    public 
  Ektron.Cms.Activity.ActivityCommentProperty 
  GroupByField { set; get; }
  • OrderByDirection. Sets the order direction (ascending or descending).
    public EkEnumeration.OrderByDirection 
  OrderByDirection { set; get; }
  • OrderByField . Set the property used to order the results.
    public Ektron.Cms.Activity.ActivityCommentProperty 
  OrderByField { set; get; }
  • PagingInfo. By default, page size is 50 for improved performance. Example paging Info: 
    PagingInfo pageinfo = new PagingInfo();
pageinfo.CurrentPage=1;
pageinfo.RecordsPerPage = 100;
criteria.PagingInfo = pageinfo;
Constructor(property, orderbyDirection)

Sorts the results by a property in ascending or descending order.

AddFilter(property, operator, value)

Filters the results based on the conditions defined in this method.

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo, Objectvalue);
LogicalOperation Condition

Filters the array of items based on the logical condition set in the AddFilter properties. 

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo,Objectvalue);
List<CriteriaFilterGroup> FilterGroups

Binds data to a listview or gridview.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCustomerPropertyLabel" AssociatedControlID="uxCustomerProperty" CssClass="span-4 last"
            runat="server" Text="* CustomerProperty :" />
        <asp:DropDownList ID="uxCustomerProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>UserName</asp:ListItem>
            <asp:ListItem>DisplayName</asp:ListItem>
        </asp:DropDownList>
    </li>                    
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last"
            runat="server" Text="* ObjectValue :" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></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="uxCustomerlist" 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>
                        User Name
                    </th>
                    <th>
                        Display Name
                    </th>
                    <th>
                        Email
                    </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("UserName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("DisplayName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("EmailAddress")%>
            </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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            object objectValue = uxObjectValue.Text;
            string customerProperty = uxCustomerProperty.SelectedItem.Text;
            CustomerManager customerManager = new CustomerManager();
            CustomerCriteria criteria = new CustomerCriteria(CustomerProperty.UserName, EkEnumeration.OrderByDirection.Ascending);
            if (customerProperty == "Id")
            {
                criteria.AddFilter(CustomerProperty.Id, CriteriaFilterOperator.EqualTo, objectValue);
            }
            else if (customerProperty == "UserName")
            {
                criteria.AddFilter(CustomerProperty.UserName, CriteriaFilterOperator.EqualTo, objectValue);
            }
            else
            {
                criteria.AddFilter(CustomerProperty.DisplayName, CriteriaFilterOperator.EqualTo, objectValue);
            }

            List<CustomerData> customerDataList = customerManager.GetList(criteria);
            uxCustomerlist.Visible = true;
            uxCustomerlist.DataSource = customerDataList;
            uxCustomerlist.DataBind();

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

IsUserNameExists

IsUserNameExists(System.String)

Returns whether the given UserName is available to add new 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 Name

Parameters

  • userName. Name of the User.

Returns

Returns true if UserName is available to add a new user; otherwise false.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserNameLabel" AssociatedControlID="uxUserName" CssClass="span-3 last"
            runat="server" Text="* UserName :" />
        <ektronUI:TextField ID="uxUserName" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="IsUserNameExists"></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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            CustomerManager customerManager = new CustomerManager();
            string userName = uxUserName.Text;
            if (userName != "")
            {
                bool isAvailable = customerManager.IsUserNameExists(userName);
                if (isAvailable == true)
                {
                    MessageUtilities.UpdateMessage(uxMessage, "UserName " + userName + " is exists in the system", Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "UserName " + userName + " is not exists in the system", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid User Name.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

SetBillingAddress

SetBillingAddress(System.Int64,System.Int64)

Sets a customers billing address.

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

  • * Customer ID
  • * Address ID

Parameters

  • customerId. ID of the customer.
  • addressId. ID of the address to be set as billing address to the customer.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCustomerIdLabel" AssociatedControlID="uxCustomerId" CssClass="span-3 last"
            runat="server" Text="* CustomerId :" />
        <ektronUI:TextField ID="uxCustomerId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressIdLabel" AssociatedControlID="uxAddressId" CssClass="span-3 last"
            runat="server" Text="* AddressId :" />
        <ektronUI:TextField ID="uxAddressId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="SetBillingAddress"></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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            CustomerManager customerManager = new CustomerManager();
            long customerId;
            long.TryParse(uxCustomerId.Text, out customerId);
            long addressId;
            long.TryParse(uxAddressId.Text, out addressId);
            if (customerId > 0 && addressId > 0)
            {
                CustomerData customerData = customerManager.GetItem(customerId);
                if (customerData != null)
                {
                    customerManager.SetBillingAddress(customerId, addressId);
                    MessageUtilities.UpdateMessage(uxMessage, "Billing Address Id " + addressId.ToString() + " is updated to Customer Id " + customerId.ToString(), Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Customer Id", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid values for required fields.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

SetShippingAddress

SetShippingAddress(System.Int64,System.Int64)

Sets a customers shipping address.

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

  • * Customer ID
  • * Address ID

Parameters

  • customerId. ID of the customer.
  • addressId. ID of the address to be set as shipping address to the customer.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCustomerIdLabel" AssociatedControlID="uxCustomerId" CssClass="span-3 last"
            runat="server" Text="* CustomerId :" />
        <ektronUI:TextField ID="uxCustomerId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAddressIdLabel" AssociatedControlID="uxAddressId" CssClass="span-3 last"
            runat="server" Text="* AddressId :" />
        <ektronUI:TextField ID="uxAddressId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="SetShippingAddress"></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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            CustomerManager customerManager = new CustomerManager();
            long customerId;
            long.TryParse(uxCustomerId.Text, out customerId);
            long addressId;
            long.TryParse(uxAddressId.Text, out addressId);
            if (customerId > 0 && addressId > 0)
            {
                CustomerData customerData = customerManager.GetItem(customerId);
                if (customerData != null)
                {
                    customerManager.SetShippingAddress(customerId, addressId);
                    MessageUtilities.UpdateMessage(uxMessage, "Shipping Address Id " + addressId.ToString() + " is updated to Customer Id " + customerId.ToString(), Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Customer Id", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid values for required fields.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update

Update(Ektron.Cms.Commerce.CustomerData)

Updates an existing customer.

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

  • * Customer ID
  • User Name
  • Password
  • Display Name
  • First Name
  • Last Name
  • Email

Parameters

  • customerData. Customer data to be updated.

Returns

Returns customer data.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCustomerIdLabel" AssociatedControlID="uxCustomerId" CssClass="span-3 last"
            runat="server" Text="* CustomerId :" />
        <ektronUI:TextField ID="uxCustomerId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserNameLabel" AssociatedControlID="uxUserName" CssClass="span-3 last"
            runat="server" Text=" UserName :" />
        <ektronUI:TextField ID="uxUserName" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>                    
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordLabel" AssociatedControlID="uxPassword" CssClass="span-3 last"
            runat="server" Text=" Password :" />
        <asp:TextBox ID="uxPassword" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            TextMode="Password" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDisplayLabel" AssociatedControlID="uxDisplay" CssClass="span-3 last"
            runat="server" Text=" DisplayName :" />
        <ektronUI:TextField ID="uxDisplay" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFirstNameLabel" AssociatedControlID="uxFirstName" CssClass="span-3 last"
            runat="server" Text=" FirstName :" />
        <ektronUI:TextField ID="uxFirstName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLastNameLabel" AssociatedControlID="uxLastName" CssClass="span-3 last"
            runat="server" Text=" LastName :" />
        <ektronUI:TextField ID="uxLastName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
 
    <li class="clearfix">
        <ektronUI:Label ID="uxEmailLabel" AssociatedControlID="uxEmail" CssClass="span-3 last"
            runat="server" Text=" Email :" />
        <ektronUI:TextField ID="uxEmail" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix" style="color: red;">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long customerId;
            long.TryParse(uxCustomerId.Text, out customerId);
            string emailAddress = uxEmail.Text;
            if (!string.IsNullOrEmpty(emailAddress))
            {
                try
                {
                    System.Net.Mail.MailAddress addr = new System.Net.Mail.MailAddress(emailAddress);
                }
                catch
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Email Address.", Message.DisplayModes.Error);
                    return;
                }
            }

            if (customerId > 0)
            {
                CustomerManager customerManager = new CustomerManager();
                CustomerData customerData = customerManager.GetItem(customerId);
                if (customerData != null)
                {
                    customerData.UserName = uxUserName.Text != "" ? uxUserName.Text : customerData.UserName;
                    customerData.Password = uxPassword.Text != "" ? uxPassword.Text : customerData.Password;
                    customerData.FirstName = uxFirstName.Text != "" ? uxFirstName.Text : customerData.FirstName;
                    customerData.LastName = uxLastName.Text != "" ? uxLastName.Text : customerData.LastName;
                    customerData.EmailAddress = emailAddress != "" ? emailAddress : customerData.EmailAddress;
                    customerData.DisplayName = uxDisplay.Text != "" ? uxDisplay.Text : customerData.DisplayName;
                    customerManager.Update(customerData);
                    MessageUtilities.UpdateMessage(uxMessage, "Customer Updated for Id: " + customerId.ToString(), Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Customer Id", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Customer Id", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

CustomerCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • CustomerCriteria()
    public CustomerCriteria()
  • CustomerCriteria(Ektron.Cms.Commerce.CustomerProperty, EkEnumeration.OrderByDirection))
    public CustomerCriteria(Ektron.Cms.Commerce.CustomerProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the CustomerProperty are:

    • BillingAddress
    • DateCreated
    • DisplayName
    • EmailAddress
    • FirstName
    • Id
    • IsDeleted
    • IsMember
    • LanguageId
    • LastName
    • ShippingAddressId
    • TotalOrders
    • TotalOrderValue
    • UserName

CustomerData

Namespace

Ektron.Cms.Commerce

Properties

  • AverageOrderValue. Gets the average order placed by this customer.
    public decimal AverageOrderValue { get; }
  • BillingAddressId. Gets or sets the Address Id of the billing address for the customer.
    public long BillingAddressId { set; get; }
  • DateCreated
    public System.DateTime DateCreated { set; get; }
  • DisplayName. Gets or sets the display name of the customer.
    public string DisplayName { set; get; }
  • EmailAddress. Gets or sets the email address of the customer.
    public string EmailAddress { set; get; }
  • FirstName. Gets or sets the first name of the customer.
    public string FirstName { set; get; }
  • Id. Gets or sets the Id of the customer.
    public long Id { set; get; }
  • IsDeleted. Gets the IsDeleted status of the customer.
    public bool IsDeleted { set; get; }
  • IsMembershipUser. Gets or sets the IsMembershipUser status of the customer.
    public bool IsMembershipUser { set; get; }
  • LanguageId. Gets or sets the integer ID of the language for the UserData object. Returns the integer ID of the language.
    public int LanguageId { set; get; }
  • LastName. Gets or sets the last of the customer.
    public string LastName { set; get; }
  • Password. Gets or sets the password for the customer.
    public string Password { set; get; }
  • ShippingAddressId. Gets or sets Address Id of the shipping address for this customer.
    public long ShippingAddressId { set; get; }
  • TotalOrders. A read-only property, it gets the total number of orders placed by the customer.
    public int TotalOrders { set; get; }
  • TotalOrderValue. A read-only property, it gets the total value of orders placed by the customer.
    public decimal TotalOrderValue { set; get; }
  • UserId. Gets or sets the Id of the Cms User object associated with this customer.
    public long UserId { set; get; }
  • UserName. Gets or sets the username for the customer.
    public string UserName { set; get; }