CouponManager

Add

Add(Ektron.Cms.Commerce.CouponData)

Adds the new coupon data object into the CMS.The CouponData.Id property is populated with the new Coupon'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

• * Coupon Code
• Coupon Type
• Is Active

Parameters

• couponData. Coupon data object to be added.

Returns

CouponData object with new coupon ID.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCouponCodeLabel" AssociatedControlID="uxCouponCode" CssClass="span-3 last" runat="server" Text="* Coupon Code:" />
        <ektronUI:TextField  ID="uxCouponCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCouponTypeLabel" AssociatedControlID="uxCouponType" CssClass="span-3 last" runat="server" Text=" Coupon Type:" />
         <asp:DropDownList ID="uxCouponType" runat="server">
            <asp:ListItem Text="BasketLevel" Value="0" >Group Id</asp:ListItem>
            <asp:ListItem Text="MostExpensiveItem" Value="1" >Group Id</asp:ListItem>
            <asp:ListItem Text="LeastExpensiveItem" Value="2" >Group Id</asp:ListItem>
            <asp:ListItem Text="AllItems" Value="3" >Group Id</asp:ListItem>            
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCouponActiveLabel" AssociatedControlID="uxCouponActive" CssClass="span-3 last" runat="server" Text=" IsActive:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxCouponActive" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </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
        {
            CouponManager couponManager = new CouponManager();
            bool isActive = false;
            if (uxCouponActive.Checked)
            {
                isActive = true;
            }
            CouponData couponData = new CouponData()
            {
                Code = uxCouponCode.Text,
                CouponType = (Ektron.Cms.Common.EkEnumeration.CouponType)int.Parse(uxCouponType.SelectedItem.Value),
                IsActive = isActive,
                
            };

            CouponData newCouponData = couponManager.Add(couponData);
            if (newCouponData.Id > 0)
            {                
                MessageUtilities.UpdateMessage(uxMessage,  "Coupon is added with Id " + couponData.Id , Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon adding process is failed", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

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

AddCouponToObject

AddCouponToObject(Ektron.Cms.Commerce.CouponEntryData)

Adds new CouponEntry data object into 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

• * Coupon ID
• * Object ID
• Object Type
• Is Included

Parameters

• couponEntryData. CouponEntryData object to be added.

.aspx code snippet

<ol class="formFields">
    <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:Label ID="uxObjectIdLabel" AssociatedControlID="uxObjectId" CssClass="span-3 last" runat="server" Text="* Object Id:" />
        <ektronUI:TextField  ID="uxObjectId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCouponTypeLabel" AssociatedControlID="uxCouponType" CssClass="span-3 last" runat="server" Text=" Coupon Type:" />
         <asp:DropDownList ID="uxCouponType" runat="server">            
            <asp:ListItem Value="1">Folder</asp:ListItem>           
            <asp:ListItem Value="20">TaxonomyNode</asp:ListItem>
            <asp:ListItem Value="21">CatalogEntry</asp:ListItem>            
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIncludedLabel" AssociatedControlID="uxCouponActive" CssClass="span-3 last" runat="server" Text=" Is Active:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxCouponActive" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>   
     <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add Coupon Application"></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
        {
            CouponManager couponManager = new CouponManager();
            bool isInclude = false;
            if (uxCouponInclude.Checked)
            {
                isInclude = true;
            }
            CouponEntryData couonEntryData = new CouponEntryData()
            {
                CouponId = long.Parse(uxCouponId.Text),
                DataState = Ektron.Cms.Common.EkEnumeration.DataState.Added,
                ObjectType = (Ektron.Cms.Common.EkEnumeration.CMSObjectTypes)int.Parse(uxObjectType.SelectedValue),
                ObjectId = long.Parse(uxObjectId.Text),                 
                IsIncluded = isInclude
            };
            couponManager.AddCouponToObject(couonEntryData);                        
            MessageUtilities.UpdateMessage(uxMessage, "Coupon "+ couonEntryData.CouponId + " is added to object " + couonEntryData.ObjectId , Message.DisplayModes.Success);                       
            uxPageMultiView.SetActiveView(uxViewMessage);

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

Deactivate

Deactivate(System.Int64)

Deactivate the existing coupon.

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

• * Coupon ID

Parameters

• couponId. ID of the coupon.

.aspx code snippet

<ol class="formFields">
   <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="Deactivate"></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
        {
            CouponManager couponManager = new CouponManager();
            long couponId = long.Parse(uxCouponId.Text);

            couponManager.Deactivate(couponId);
            MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is deactivated", Message.DisplayModes.Success );

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

Delete

Delete(System.Int64)

Deletes an existing coupon 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

• * Coupon ID

Parameters

• couponId. ID of the coupon to be deleted.

.aspx code snippet

<ol class="formFields">
   <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="Delete"></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
        {
            CouponManager couponManager = new CouponManager();
            long couponId = long.Parse(uxCouponId.Text);

            couponManager.Delete(couponId);
            MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is deleted", Message.DisplayModes.Success );

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

DeleteCouponApplications

DeleteCouponApplications(System.Int64,System.Collections.Generic.IEnumerable,Ektron.Cms.Common.EkEnumeration.CMSObjectTypes)

Deletes the existing Coupon Applications 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

• * Coupon ID
• * Object IDs
• Object Type

Parameters

• couponId. ID of the coupon.
• exclusionIdList. List of IDs not included for delete.
• objectType. Object type of CMSObjectTypes. Only Folder, Taxonomy and CatalogEntry object types are allowed.

.aspx code snippet

<ol class="formFields">
    <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:Label ID="uxObjectIdLabel" AssociatedControlID="uxObjectId" CssClass="span-3 last" runat="server" Text="* Object Id:" />
        <ektronUI:TextField  ID="uxObjectId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCouponTypeLabel" AssociatedControlID="uxCouponType" CssClass="span-3 last" runat="server" Text=" Coupon Type:" />
         <asp:DropDownList ID="uxCouponType" runat="server">              
            <asp:ListItem Value="1">Folder</asp:ListItem>            
            <asp:ListItem Value="20">TaxonomyNode</asp:ListItem>
            <asp:ListItem Value="21">CatalogEntry</asp:ListItem>            
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="DeleteCoupon Application"></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
        {
            CouponManager couponManager = new CouponManager();
            long couponId=0;
             long.TryParse(uxCouponId.Text,out couponId);
            List<string> list = uxObjectIds.Text.Split(',').ToList();            
            List<long> listObjectIds = list.ConvertAll<long>(delegate(string x) { return long.Parse(x); });
            Ektron.Cms.Common.EkEnumeration.CMSObjectTypes objectType = (Ektron.Cms.Common.EkEnumeration.CMSObjectTypes)int.Parse(uxObjectType.SelectedValue);

            couponManager.DeleteCouponApplications(couponId, listObjectIds, objectType);
            MessageUtilities.UpdateMessage(uxMessage, "Coupon application is deleted", Message.DisplayModes.Success);
            
            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetCatalogList

GetCatalogList(Ektron.Cms.Commerce.CouponEntryCriteria)

Retrieves the list of coupon entry item based on the 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

• Coupon Entry Property
• * Object Value

Parameters

• criteria. Criteria used to retrieve the coupon entry.

Returns

Returns the list of CouponEntryData objects.

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="uxCouponEntryPropertyLabel" AssociatedControlID="uxCouponEntryProperty" CssClass="span-4 last" runat="server" Text="CouponEntryProperty:" />
        <asp:DropDownList ID="uxCouponEntryProperty" runat="server">
            <asp:ListItem>Coupon Id</asp:ListItem>
            <asp:ListItem>Object ID</asp:ListItem>
            <asp:ListItem>Title </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="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></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="uxCouponEntryListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                       Coupon Id
                    </th>
                    <th>
                        Object Id
                    </th>
                    <th>
                        Title
                    </th>
                    <th>
                        Path
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("CouponId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ObjectId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Title")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Path")%>
            </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
        {
            object Objectvalue;
            CouponEntryCriteria criteria = new CouponEntryCriteria();

            if (uxCouponEntryProperty.SelectedItem.Text == "Coupon Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(CouponEntryProperty.CouponId , Ektron.Cms.Common.CriteriaFilterOperator.EqualTo,Objectvalue );
            }
            else if (uxCouponEntryProperty.SelectedItem.Text == "Object Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(CouponEntryProperty.ObjectId  , Ektron.Cms.Common.CriteriaFilterOperator.EqualTo,Objectvalue );
            }            
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(CouponEntryProperty.Title, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo,Objectvalue );
            }

            CouponManager couponManger = new CouponManager();            
            List<CouponEntryData> couponEntryList = couponManger.GetCatalogList(criteria);

            uxCouponEntryListView.Visible = true;
            uxCouponEntryListView.DataSource = couponEntryList;
            uxCouponEntryListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetCouponId

GetCouponId(System.String)

Retrieve the coupon ID by coupon code.

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

• * Coupon Code

Parameters

• couponCode. Code of the coupon.

Returns

Returns the coupon ID.

.aspx code snippet

<ol class="formFields">
     <li class="clearfix">
        <ektronUI:Label ID="uxCouponCodeLabel" AssociatedControlID="uxCouponCode" CssClass="span-3 last" runat="server" Text="* Coupon Code:" />
        <ektronUI:TextField  ID="uxCouponCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>    
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetCouponId"></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
        {
            CouponManager couponManager = new CouponManager();
            long couponId = 0;

            couponId = couponManager.GetCouponId(uxCouponCode.Text);

            if (couponId > 0)
            {             
                MessageUtilities.UpdateMessage(uxMessage,  "Code for the Coupon is " + couponId , Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Code "+uxCouponCode.Text +"does not exists", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetItem

GetItem(System.Int64)

Retrieve the single coupon item by 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

• * ID

Parameters

• couponId. ID of the coupon to retrieved.

Returns

Returns the CouponData object.

.aspx code snippet

<ol class="formFields">
     <li class="clearfix">
        <ektronUI:Label ID="uxCouponIDLabel" AssociatedControlID="uxCouponId" CssClass="span-3 last" runat="server" Text="* 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="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" 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="uxCode" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDescription" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxExpirationDate" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxExpiriationDate" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDiscountType" 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;
using Ektron.Cms.Framework.User;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            CouponManager couponManager = new CouponManager();
            long couponId=long.Parse(uxCouponId.Text);
            CouponData couponData = couponManager.GetItem(couponId);

            if (couponData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for coupon with ID " + couponData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxCode.Text = "Code : " + couponData.Code;
                uxDescription.Text = "Description : " + couponData.Description;
                uxIsCombineable.Text = "IsCombineable : " + couponData.IsCombinable;
                uxExpirationDate.Text = "ExpirationDate : " + couponData.ExpirationDate;
                uxDiscountType.Text = "Discount Type : "  + couponData.DiscountType;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon "+couponId + "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(Ektron.Cms.Commerce.CouponCriteria)

Retrieves the list of coupon item based on the 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

• Coupon Property
• * Object Value

Parameters

• criteria. Criteria used to retrieve the coupon.

Returns

Returns the list of CouponData objects.

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="uxCouponPropertyLabel" AssociatedControlID="uxCouponProperty" CssClass="span-4 last" runat="server" Text="CouponProperty:" />
        <asp:DropDownList ID="uxCouponProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Code</asp:ListItem>
            <asp:ListItem>Currency Id </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="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></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>
                       Code
                    </th>
                    <th>
                        Description
                    </th>
                    <th>
                        Expiration Date
                    </th>
                    <th>
                        IsActive
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Code")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Description")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ExpirationDate")%>
            </td>
            <td class="devsite-method">
                <%# Eval("IsActive")%>
            </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
        {
            object Objectvalue;
            CouponCriteria criteria = new CouponCriteria();

            if (uxCouponProperty.SelectedItem.Text == "Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(CouponProperty.Id, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxCouponProperty.SelectedItem.Text == "Code")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(CouponProperty.Code, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(CouponProperty.CurrencyId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            CouponManager couponManger = new CouponManager();            
            List<CouponData> couponList = couponManger.GetList(criteria);

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

            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetProductList

GetProductList(Ektron.Cms.Commerce.CouponEntryCriteria)

Retrieves the list of product coupon item based on the 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

• * Object Value

Parameters

• criteria. Criteria used to retrieve the product coupon entry.

Returns

Returns the list of product CouponEntryData objects.

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="uxCouponEntryPropertyLabel" AssociatedControlID="uxCouponEntryProperty" CssClass="span-4 last" runat="server" Text="CouponEntryProperty:" />
        <asp:DropDownList ID="uxCouponEntryProperty" runat="server">
            <asp:ListItem>Coupon Id</asp:ListItem>
            <asp:ListItem>Object ID</asp:ListItem>
            <asp:ListItem>Title </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="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></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="uxCouponEntryListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                       Coupon Id
                    </th>
                    <th>
                        Object Id
                    </th>
                    <th>
                        Title
                    </th>
                    <th>
                        EntryType
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("CouponId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ObjectId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Title")%>
            </td>
            <td class="devsite-method">
                <%# Eval("EntryType")%>
            </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
        {
            object Objectvalue;
            CouponEntryCriteria criteria = new CouponEntryCriteria();
            

            if (uxCouponEntryProperty.SelectedItem.Text == "Coupon Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(CouponEntryProperty.CouponId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxCouponEntryProperty.SelectedItem.Text == "Object Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(CouponEntryProperty.ObjectId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(CouponEntryProperty.Title, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            CouponManager couponManger = new CouponManager();
            List<ProductCouponEntryData> couponEntryList = couponManger.GetProductList(criteria);

            uxCouponEntryListView.Visible = true;
            uxCouponEntryListView.DataSource = couponEntryList;
            uxCouponEntryListView.DataBind();

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

GetTaxonomyList

GetTaxonomyList(Ektron.Cms.Commerce.CouponEntryCriteria)

Retrieves the list of coupon entry item based on the 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

• * Object Value

Parameters

• criteria. Criteria used to retrieve the coupon entry.

Returns

Returns the list of CouponEntryData objects.

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="uxCouponEntryPropertyLabel" AssociatedControlID="uxCouponEntryProperty" CssClass="span-4 last" runat="server" Text="CouponEntryProperty:" />
        <asp:DropDownList ID="uxCouponEntryProperty" runat="server">
            <asp:ListItem>Coupon Id</asp:ListItem>
            <asp:ListItem>Object ID</asp:ListItem>
            <asp:ListItem>Title </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="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></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="uxCouponEntryListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                       Coupon Id
                    </th>
                    <th>
                        Object Id
                    </th>
                    <th>
                        Title
                    </th>
                    <th>
                        Path
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("CouponId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ObjectId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Title")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Path")%>
            </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
        {
            object Objectvalue;
            CouponEntryCriteria criteria = new CouponEntryCriteria();

            if (uxCouponEntryProperty.SelectedItem.Text == "Coupon Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(CouponEntryProperty.CouponId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxCouponEntryProperty.SelectedItem.Text == "Object Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(CouponEntryProperty.ObjectId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(CouponEntryProperty.Title, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            CouponManager couponManger = new CouponManager();
            List<CouponEntryData> couponEntryList = couponManger.GetTaxonomyList(criteria);

            uxCouponEntryListView.Visible = true;
            uxCouponEntryListView.DataSource = couponEntryList;
            uxCouponEntryListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

IsCouponApplicabletoSubscriptions

IsCouponApplicabletoSubscriptions(System.Int64)

Checks whether the coupon is applicable to the subscription.

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

• * Coupon ID

Parameters

• couponId. ID of the coupon.

Returns

Returns true, if the coupon is applicable to the subscriptions; otherwise false.

.aspx code snippet

<ol class="formFields">
   <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="IsCouponApplicable"></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
        {
            CouponManager couponManager = new CouponManager();
            long couponId = long.Parse(uxCouponId.Text);

            bool result = couponManager.IsCouponApplicabletoSubscriptions(couponId);
            if (result)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is applicable to the subscription", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is not applicable to the subscription", Message.DisplayModes.Information);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

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

IsCouponAppliedToObject

IsCouponAppliedToObject(System.Int64,System.Int64,Ektron.Cms.Common.EkEnumeration.CMSObjectTypes)

Checks whether the coupon is applied to the particular object.

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

• * Coupon ID
• * Object ID
• Object Type

Parameters

• couponId. ID of the coupon.
• objectId. ID of the object.
• objectType. CmsObjectTypes enum.

Returns

Returns true, if the coupon is applied to the object; otherwise false.

.aspx code snippet

<ol class="formFields">
    <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:Label ID="uxObjectIdLabel" AssociatedControlID="uxObjectId" CssClass="span-3 last" runat="server" Text="* Object Id:" />
        <ektronUI:TextField  ID="uxObjectId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCouponTypeLabel" AssociatedControlID="uxCouponType" CssClass="span-3 last" runat="server" Text=" Coupon Type:" />
         <asp:DropDownList ID="uxCouponType" runat="server">
            <asp:ListItem Value="0">Content</asp:ListItem>
            <asp:ListItem Value="1">Folder</asp:ListItem>
            <asp:ListItem Value="2">User</asp:ListItem>
            <asp:ListItem Value="3">UserGroup</asp:ListItem>
            <asp:ListItem Value ="4">Library</asp:ListItem>
            <asp:ListItem Value="5">Collection</asp:ListItem>
            <asp:ListItem Value="6">Menu</asp:ListItem>
            <asp:ListItem Value="7">Calendar</asp:ListItem>
            <asp:ListItem Value="8">Subscription</asp:ListItem>
            <asp:ListItem Value="9">Notification</asp:ListItem>
            <asp:ListItem Value="10">Blog</asp:ListItem>
            <asp:ListItem Value="11">BlogPost</asp:ListItem>
            <asp:ListItem Value="12">BlogComment</asp:ListItem>
            <asp:ListItem Value="13">DiscussionBoard</asp:ListItem>
            <asp:ListItem Value="14">DiscussionForum</asp:ListItem>
            <asp:ListItem Value="15">RestrictIP</asp:ListItem>
            <asp:ListItem Value="16">ReplaceWord</asp:ListItem>
            <asp:ListItem Value="17">UserRank</asp:ListItem>
            <asp:ListItem Value="18">DiscussionTopic</asp:ListItem>
            <asp:ListItem Value="19">CommunityGroup</asp:ListItem>
            <asp:ListItem Value="20">TaxonomyNode</asp:ListItem>
            <asp:ListItem Value="21">CatalogEntry</asp:ListItem>
            <asp:ListItem Value="22">MessageBoard</asp:ListItem>
            <asp:ListItem Value="23">CalendarEvent</asp:ListItem>
            <asp:ListItem Value="24">MicroMessage</asp:ListItem>
            <asp:ListItem Value="25">Subscriber</asp:ListItem>
        </asp:DropDownList>
    </li>     
     <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="IsCouponApplied"></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
        {
            CouponManager couponManager = new CouponManager();
            long couponId = long.Parse(uxCouponId.Text);
            long objectId = long.Parse(uxObjectId.Text);
            Ektron.Cms.Common.EkEnumeration.CMSObjectTypes objectType= (Ektron.Cms.Common.EkEnumeration.CMSObjectTypes) int.Parse(uxObjectType.SelectedValue);

            bool result = couponManager.IsCouponAppliedToObject(couponId, objectId, objectType);
            if (result)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is applied to the object", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is not applied to the object", Message.DisplayModes.Information);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

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

IsCouponUsedForBasket

IsCouponUsedForBasket(System.Int64)

Checks whether the coupon is used in 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

• * Coupon ID

Parameters

• couponId. ID of the coupon.

Returns

Returns true, if the coupon is used in any basket; otherwise false.

.aspx code snippet

<ol class="formFields">
   <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="IsCouponUsed"></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
        {
            CouponManager couponManager = new CouponManager();
            long couponId = long.Parse(uxCouponId.Text);

            bool result = couponManager.IsCouponUsedForBasket(couponId);
            if (result)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is used in the basket", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is not used in the basket", Message.DisplayModes.Information);
            }

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

IsCouponUsedForOrder

IsCouponUsedForOrder(System.Int64)

Checks whether the coupon is used in any order.

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

• * Coupon ID

Parameters

• couponId. ID of the coupon.

Returns

Returns true, if the coupon is used in order; otherwise false.

.aspx code snippet

<ol class="formFields">
   <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="IsCouponUsed"></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
        {
            CouponManager couponManager = new CouponManager();
            long couponId = long.Parse(uxCouponId.Text);

            bool result = couponManager.IsCouponUsedForOrder(couponId);
            if (result)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is used in the order", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is not used in the order", Message.DisplayModes.Information);
            }

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

SaveCouponApplications

SaveCouponApplications(System.Int64,System.Collections.Generic.List)

Saves all the applications (taxonomy, catalog, product) for a given coupon. This is assumed to be an all inclusive lists. Any existing coupon applications that are not included are deleted.

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

• * Coupon ID
• * Object ID
• Object Type

Parameters

• couponId. ID of coupon to update.
• couponEntryList. List of all CouponEntryData applications for the given coupon.

.aspx code snippet

<ol class="formFields">
    <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:Label ID="uxObjectIdLabel" AssociatedControlID="uxObjectId" CssClass="span-3 last" runat="server" Text="* Object Id:" />
        <ektronUI:TextField  ID="uxObjectId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCouponTypeLabel" AssociatedControlID="uxCouponType" CssClass="span-3 last" runat="server" Text=" Coupon Type:" />
         <asp:DropDownList ID="uxCouponType" runat="server">            
            <asp:ListItem Value="1">Folder</asp:ListItem>            
            <asp:ListItem Value="20">TaxonomyNode</asp:ListItem>
            <asp:ListItem Value="21">CatalogEntry</asp:ListItem>            
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIncludedLabel" AssociatedControlID="uxCouponActive" CssClass="span-3 last" runat="server" Text=" Is Active:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxCouponActive" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>   
     <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="SaveCoupon Application"></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
        {
            CouponManager couponManager = new CouponManager();
            bool isInclude = false;
            long couponId = long.Parse(uxCouponId.Text);
            List<CouponEntryData> listCouponEntry = new List<CouponEntryData>();
            if (uxCouponInclude.Checked)
            {
                isInclude = true;
            }
            CouponEntryData couonEntryData = new CouponEntryData()
            {
                CouponId = couponId ,
                DataState = Ektron.Cms.Common.EkEnumeration.DataState.Added,
                ObjectType = (Ektron.Cms.Common.EkEnumeration.CMSObjectTypes)int.Parse(uxObjectType.SelectedValue),
                ObjectId = long.Parse(uxObjectId.Text),
                IsIncluded = isInclude
            };
            listCouponEntry.Add(couonEntryData);
            couponManager.SaveCouponApplications(couponId, listCouponEntry); 
            MessageUtilities.UpdateMessage(uxMessage, "Coupon application is saved" + couonEntryData.ObjectId, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

Update

Update(Ektron.Cms.Commerce.CouponData)

Updates the existing coupon data object.

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

• * Coupon ID
• Coupon Description
• Discount Value

Parameters

• couponData. CouponData object to be updated.

Returns

Updated coupon data is returned.

.aspx code snippet

<ol class="formFields">
    <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:Label ID="uxCouponDescriptionLabel" AssociatedControlID="uxCouponDescription" CssClass="span-3 last" runat="server" Text=" Coupon Description:" />
        <ektronUI:TextField  ID="uxCouponDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDiscountLable" AssociatedControlID="uxDiscountValue" CssClass="span-3 last" runat="server" Text=" Discount Value:" />
        <ektronUI:TextField  ID="uxDiscountValue" 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-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
        {
            CouponManager couponManager = new CouponManager();
            long counponId=long.Parse(uxCouponId.Text);
            CouponData couponData = couponManager.GetItem(counponId);
            if (couponData != null)
            {                
                couponData.Description = uxCouponDescription.Text;
                couponData.DiscountValue = Decimal.Parse(uxDiscountValue.Text);
                couponManager.Update(couponData);
                
                MessageUtilities.UpdateMessage(uxMessage, "Coupon updated with Id " + couponData.Id, Message.DisplayModes.Success);                
            }
            uxPageMultiView.SetActiveView(uxViewMessage);


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

Validate (coupon)

Validate(System.Int64)

Validate the coupon by coupon 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

• * Coupon ID

Parameters

• couponId. ID of the coupon to validate.

Returns

Returns true if validation is true; otherwise false.

.aspx code snippet

<ol class="formFields">
   <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="Validate"></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
        {
            CouponManager couponManager = new CouponManager();
            long couponId = long.Parse(uxCouponId.Text);

            bool result = couponManager.Validate(couponId);
            if (result)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is valid", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is not valid", Message.DisplayModes.Information);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

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

Validate (product)

Validate(System.Int64,System.Int64)

Validate the coupon by coupon id and product 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

• * Coupon ID
• * Product ID

Parameters

• couponId. ID of the coupon.
• productId. ID of the product.

Returns

Returns true if validation is true; otherwise false.

.aspx code snippet

<ol class="formFields">
   <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:Label ID="uxProductIdLabel" AssociatedControlID="uxProductId" CssClass="span-3 last" runat="server" Text="* Product Id:" />
        <ektronUI:TextField  ID="uxProductId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li> 
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Validate"></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
        {
            CouponManager couponManager = new CouponManager();
            long couponId = long.Parse(uxCouponId.Text);
            long productId = long.Parse(uxProductId.Text);

            bool result = couponManager.Validate(couponId,productId);
            if (result)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is valid", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Coupon " + couponId + " is not valid", Message.DisplayModes.Information);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);


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

CouponCriteria

Namespace

Ektron.Cms.Commerce

Constructors

• CouponCriteria()

  public CouponCriteria()

• CouponCriteria(Ektron.Cms.Commerce.CouponProperty, EkEnumeration.OrderByDirection)

  public 
    CouponCriteria(Ektron.Cms.Commerce.CouponProperty 
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the CouponProperty are:

  • AppliesToQuantity
  • ApplyOneTime
  • Code
  • CouponType
  • CurrencyId
  • Description
  • DiscountType
  • DiscountValue
  • ExpirationDate
  • Id
  • IsActive
  • IsApplicabletoSubscriptions
  • IsCombinable
  • IsRedeemable
  • MaximumAmount
  • MaximumUses
  • MinimumAmount
  • StartDate
  • UseCount

CouponData

Namespace

Ektron.Cms.Commerce

Properties

• AppliesToQuantity. For an DiscountType.Amount coupon, defines the applicable quantity for a single line in a basket. Default is 1. Example, if you have a $5 Amount coupon, and a quantity 5 of a $10 item (total cost $50), by default the coupon applies to the first item only: $50 - $5 = $45. Change the AppliesToQuantity value to 2, the coupon applies to 2 of the item quantity: $50 - $10 = $40. Change the AppliesToQuantity value to 3, the coupon applies to 3 of the item quantity: $50 - $15 = $35. And so on...

  public bool AppliesToQuantity { set; get; }

• Code. Gets or sets the coupon code.

  public string Code { set; get; }

• CouponData()

  public CouponData()

• CouponData(long, string, System.DateTime, System.DateTime, EkEnumeration.CouponDiscountType, decimal, decimal, EkEnumeration.CouponType, int, bool, int).

  public CouponData(long couponId, string couponCode, 
    System.DateTime startDate, System.DateTime expirationDate, 
    EkEnumeration.CouponDiscountType discountType, 
    decimal discountValue, decimal minimumAmount, 
    EkEnumeration.CouponType couponType, int maximumUses, 
    bool applyOnePerCustomer, int currencyId)

• CouponType. Gets or sets the coupon type.

  public EkEnumeration.CouponType CouponType { set; get; }

• CreateFixedDiscountCoupon(string, System.DateTime, System.DateTime, decimal, decimal, EkEnumeration.CouponType, int, bool, int)

  public static Ektron.Cms.Commerce.CouponData
    CreateFixedDiscountCoupon(string couponCode, 
      System.DateTime startDate, System.DateTime 
      expirationDate, decimal discountAmount, 
      decimal minimumAmount, EkEnumeration.CouponType 
      couponType, int maximumUses, bool applyOnePerCustomer, 
      int currencyId)

• CreateFreeShippingCoupon(string, System.DateTime, System.DateTime, decimal, EkEnumeration.CouponType, int, bool)

  public static Ektron.Cms.Commerce.CouponData 
    CreateFreeShippingCoupon(string couponCode, 
      System.DateTime startDate, System.DateTime expirationDate,
      decimal minimumAmount, EkEnumeration.CouponType couponType,
      int maximumUses, bool applyOnePerCustomer)

• CreatePercentageDiscountCoupon(string, System.DateTime, System.DateTime, decimal, decimal, EkEnumeration.CouponType, int, bool, int)

  public static Ektron.Cms.Commerce.CouponData 
    CreatePercentageDiscountCoupon(string couponCode, 
      System.DateTime startDate, System.DateTime expirationDate,
      decimal discountPercentage, decimal minimumAmount,
      EkEnumeration.CouponType couponType, int maximumUses, 
      bool applyOnePerCustomer, int currencyId)

• CurrencyId. Gets or sets the Id of the currency this coupon applies to.

  public int CurrencyId { set; get; }

• Description. Gets or sets the description of the coupon.

  public string Description { set; get; }

• DiscountType. Gets or sets the Coupon Discount Type.

  public EkEnumeration.CouponDiscountType DiscountType { set; get; }

• DiscountValue. Gets or sets the value of the discount. For a fixed amount, this would be the amount (i.e. 5.00). For percentage, it would be the discount percent value in whole numbers (i.e. 15% = 15.00).

  public decimal DiscountValue { set; get; } 

• ExpirationDate. Gets or sets the date the coupon expires.

  public System.DateTime ExpirationDate { set; get; }

• Id. Gets or sets the Id of the coupon.

  public long Id { set; get; }

• IsActive. Determines whether or not this coupon is currently active. Deleted coupons remain in the system and are marked inactive.

  public bool IsActive { set; get; }

• IsApplicabletoSubscription. Determines whether this coupon is applicable to subscription.

  public bool IsApplicabletoSubscriptions { set; get; }

• IsCombinable. Determines whether or not this coupon can be combined with other coupons. If true, this coupon can be combined with other "Combinable" coupons.

  public bool IsCombinable { set; get; }

• IsRedeemable. Determines whether or not this coupon is currently redeemable. A coupon may not be reddemable if the it is inactive, not within its valid period, or has been redeemed the maximum number of times.

  public bool IsRedeemable { set; get; }

• MaximumAmount. Gets or sets the maximum order amount that this coupon can be applied to.

   public decimal MaximumAmount { set; get; }

• MaximumUses. Gets or sets the maximim number of times this coupon can be used before it expires.

  public int MaximumUses { set; get; }

• MinimumAmount. Gets or sets the minimum order amount required before the coupon is applicable.

  public decimal MinimumAmount { set; get; }

• OnePerCustomer. Gets or sets the OnePerCuster value. If true, this coupon can only be used once by each customer.

  public bool OnePerCustomer { set; get; }

• StartDate. Gets or sets the date the coupon becomes valid.

  public System.DateTime StartDate { set; get; }

• UserCount. Returns the count representing the number of orders that this coupon has been applied to.

  public long UseCount { set; get; }

• Validate. Validates the CouponData object is valid for saving. Returns a ValidationResult object with any validation errors.

  public ValidationResults Validate()

CouponEntryCriteria

Namespace

Ektron.Cms.Commerce

Constructors

• CouponEntryCriteria()

  public CouponEntryCriteria()

• CouponEntryCriteria(Ektron.Cms.Commerce.CouponEntryProperty, EkEnumeration.OrderByDirection)

  public 
    CouponEntryCriteria(Ektron.Cms.Commerce.CouponEntryProperty 
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the CouponEntryProperty are:

  • CouponId
  • IsIncluded
  • ObjectId
  • ObjectType
  • Path
  • Title

CouponEntryData

Namespace

Ektron.Cms.Commerce

Properties

• Clone()

  public virtual Ektron.Cms.Commerce.CouponEntryData Clone()

• CouponEntryData()

  public CouponEntryData()

• CouponEntryData(long, EkEnumeration.CMSObjectTypes, long, string, bool). Gets or sets the Id of the coupon.

  public CouponEntryData(long objectId, 
    EkEnumeration.CMSObjectTypes objectType, 
    long couponId, string title, bool isIncluded)

• CouponId. Gets or sets the ID of the coupon.

  public long CouponId { set; get; }

• DataState. Gets or sets the current saved state for the CouponEntry. Used by the Cms internally.

  public EkEnumeration.DataState DataState { set; get; }

• IsIncluded. Gets or sets whether or not the Object is included in the coupon. If true, the object is included in the coupon. If false, the coupon is NOT included in the coupon.

  public bool IsIncluded { set; get; }

• ObjectId. Gets or sets the Id of object the coupon is applied to.

  public long ObjectId { set; get; }

• ObjectType. Gets or sets the type of object this coupon is applied to.

  public EkEnumeration.CMSObjectTypes ObjectType { set; get; }

• Path. Gets or sets the Path of the object.

  public string Path { set; get; }

• Title. Gets or sets the Title of the object.

  public string Title { set; get; }