OrderManager

ApplyCoupon. Applies a coupon to a specific order.

ApplyCoupon

ApplyCoupon(System.Int64,System.Int64)

Applies a coupon to a specific 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

* Order ID
* Coupon ID

Parameters

orderId. ID of the order.
couponId. ID of the coupon.

.aspx code snippet

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

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.OrderManager orderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            long orderId = long.Parse(uxOrderId.Text);
            long CouponId = long.Parse(uxCouponId.Text);
            OrderData orderData = orderManager.GetItem(orderId);
            if (orderData != null && orderData.Id > 0)
            {
                orderManager.ApplyCoupon(orderId, CouponId);
                MessageUtilities.UpdateMessage(uxMessage, "Coupon with Id " + CouponId + " is applied to Order "+orderId, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " does not exists.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Capture (order). Captures the payment for an order.

Capture (order)

Capture(System.Int64)

Captures the payment for an 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

* Order ID

Parameters

orderId. ID of the order.

.aspx code snippet

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

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.OrderManager orderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            long orderId = long.Parse(uxOrderId.Text);            
            OrderData orderData = orderManager.GetItem(orderId);
            if (orderData != null && orderData.Id > 0)
            {
                orderManager.Capture(orderId);
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " is captured.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " does not exists.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

Capture (payment). Captures the payment for an order.

Capture (payment)

Capture(System.Int64,System.Int64)

Captures the payment for an 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

* Order ID
* Payment ID

Parameters

orderId. ID of an order.
paymentId. ID of the payment.

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxOrderIdLabel" AssociatedControlID="uxOrderId" CssClass="span-3 last" runat="server" Text="* Order Id:" />
        <ektronUI:TextField  ID="uxOrderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>   
    <li class="clearfix">
        <ektronUI:Label ID="uxPaymentIdLabel" AssociatedControlID="uxPaymentId" CssClass="span-3 last" runat="server" Text="* Payment Id:" />
        <ektronUI:TextField  ID="uxPaymentId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>   
     <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Capture"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.OrderManager orderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            long orderId = long.Parse(uxOrderId.Text);
            long paymentId = long.Parse(uxPaymentId.Text);
            OrderData orderData = orderManager.GetItem(orderId);            
            if (orderData != null && orderData.Id > 0)
            {
                orderManager.Capture(orderId,paymentId);
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " is captured.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " does not exists.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

Delete. Deletes the order.

Delete

Delete(System.Int64)

Deletes the order by giving the option only to e-commerce administrator or site administrator.

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

* Order ID

Parameters

orderId. ID of the order.

.aspx code snippet

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

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.OrderManager orderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            long orderId = long.Parse(uxOrderId.Text);
            orderManager.Delete(orderId);
            OrderData orderData = orderManager.GetItem(orderId);
            if (orderData == null || orderData.Id == 0)
            {                
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " is deleted.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " is not deleted.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

GetItem. Retrieves a single order.

GetItem

GetItem(System.Int64)

Retrieves a single 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

* Order ID

Parameters

orderId. ID of order to retrieve.

Returns

OrderData object.

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxOrderIdLabel" AssociatedControlID="uxOrderId" CssClass="span-3 last" runat="server" Text="* Order Id:" />
        <ektronUI:TextField  ID="uxOrderId" 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-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="uxBillingAddressId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxStatus" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCustomerName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCustomerType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCurrenyId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCurrencyName" 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.Commerce;
using Ektron.Cms.Framework.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.OrderManager orderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            long orderId = long.Parse(uxOrderId.Text);            
            OrderData orderData = orderManager.GetItem(orderId);
            if (orderData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for Order with ID " + orderData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxBillingAddressId.Text = "Billing AddressId : " + orderData.BillingAddressId; 
                uxStatus.Text  = "Status : " + orderData.Status;
                uxCurrencyName.Text = "Customer Name : " + orderData.Customer.UserName;
                uxCustomerType.Text = "Customer Type : " + orderData.CustomerType;
                uxCurrenyId.Text = "Currency Id : " + orderData.Currency.Id;
                uxCurrencyName.Text = "Currency Name : " + orderData.Currency.Name;                
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " does not exists.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

GetList. Retrieves a list of orders.

GetList

GetList(Ektron.Cms.Commerce.OrderCriteria)

Retrieves a list of orders.

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

Order Property
* Object Value

Parameters

criteria. Criteria by which to retrieve orders.

Returns

List of OrderData 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="uxOrderPropertyLabel" AssociatedControlID="uxOrderProperty" CssClass="span-4 last" runat="server" Text="Order Property:" />
        <asp:DropDownList ID="uxOrderProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Name</asp:ListItem>
            <asp:ListItem>AddressId </asp:ListItem>            
            <asp:ListItem>Currency </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="uxOrderListView" 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>
                       BillingId
                    </th>
                    <th>
                       Customer Name
                    </th>
                    <th>
                        Currency Name
                    </th>
                    <th>
                         Order Total
                    </th>
                    <th>
                       CouponUsed
                    </th>
                    <th>
                       WorkflowId
                    </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("BillingAddressId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Customer.UserName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Currency.Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("OrderTotal")%>
            </td>
            <td class="devsite-method">
                <%# Eval("CouponUsed")%>
            </td>
            <td class="devsite-method">
                <%# Eval("WorkflowId")%>
            </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;
            OrderCriteria criteria = new OrderCriteria();

            if (uxOrderProperty.SelectedItem.Text == "Id")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(OrderProperty.Id, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxOrderProperty.SelectedItem.Text == "BillingId")
            {
                Objectvalue =long.Parse(uxObjectValue.Text);
                criteria.AddFilter(OrderProperty.BillingId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxOrderProperty.SelectedItem.Text == "CustomerId")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(OrderProperty.CustomerId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue =int.Parse(uxObjectValue.Text);
                criteria.AddFilter(OrderProperty.CurrencyId  , Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            Ektron.Cms.Framework.Commerce.OrderManager orderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            List<OrderData> orderList = orderManager.GetList(criteria);

            uxOrderListView.Visible = true;
            uxOrderListView.DataSource = orderList;
            uxOrderListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetOrderPaymentList. Returns the list of order payment data.

GetOrderPaymentList

GetOrderPaymentList(Ektron.Cms.Commerce.OrderPaymentCriteria)

Returns the list of order payment data.

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

Order Payment Property
* Object Value

Parameters

criteria. Criteria by which to retrieve orders.

Returns

List of Order Payment Data.

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="uxOrderPaymentPropertyLabel" AssociatedControlID="uxOrderPaymentProperty" CssClass="span-4 last" runat="server" Text="OrderPayment Property:" />
        <asp:DropDownList ID="uxOrderPaymentProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>OrderId</asp:ListItem>
            <asp:ListItem>PaymentGateway </asp:ListItem>            
            <asp:ListItem>CurrencyId </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="GetOrderPaymentList"></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="uxOrderListView" 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>
                       OrderId
                    </th>
                    <th>
                       Gateway
                    </th>                    
                    <th>
                       Last4Digits
                    </th>
                    <th>
                       PaymentType
                    </th>
                    <th>
                       PaymentDate
                    </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("OrderId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Gateway")%>
            </td>            
            <td class="devsite-method">
                <%# Eval("Last4Digits")%>
            </td>
            <td class="devsite-method">
                <%# Eval("PaymentType")%>
            </td>
            <td class="devsite-method">
                <%# Eval("PaymentDate")%>
            </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;
            OrderPaymentCriteria criteria = new OrderPaymentCriteria();

            if (uxOrderPaymentProperty.SelectedItem.Text == "Id")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(OrderPaymentProperty.Id, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxOrderPaymentProperty.SelectedItem.Text == "OrderId")
            {
                Objectvalue =long.Parse(uxObjectValue.Text);
                criteria.AddFilter(OrderPaymentProperty.OrderId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxOrderPaymentProperty.SelectedItem.Text == "PaymentGateway")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(OrderPaymentProperty.PaymentGateway, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue =int.Parse(uxObjectValue.Text);
                criteria.AddFilter(OrderPaymentProperty.CurrencyId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            Ektron.Cms.Framework.Commerce.OrderManager orderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            List<OrderPaymentData> orderPaymentList = orderManager.GetOrderPaymentList(criteria);

            uxOrderPaymentListView.Visible = true;
            uxOrderPaymentListView.DataSource = orderPaymentList;
            uxOrderPaymentListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetStatus. Returns the status of an order.

GetStatus

GetStatus(System.Int64)

Returns the status of an 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

* Order ID

Parameters

orderId. ID of order to retrieve status for.

Returns

Order status.

.aspx code snippet

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

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.OrderManager orderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            long orderId = long.Parse(uxOrderId.Text);            
            OrderData orderData = orderManager.GetItem(orderId);
            if (orderData != null)
            {
                Ektron.Cms.Common.EkEnumeration.OrderStatus status = orderManager.GetStatus(orderId);
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " status is "+status +".", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " does not exists.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

PlaceOrder. Create an order.

PlaceOrder

PlaceOrder(System.Int64,System.Int64,System.Int64,System.Int64,System.Int64,Ektron.Cms.Commerce.PaymentMethod,System.String,System.String)

Create an order to the CMS.

Authenticated users

CMS Administrators
Users that have access permission

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

Fields

*=Required

* Basket ID
* Customer ID
* Billing Address ID
* Shipping Address ID
* Shipping Method ID
Special Instruction
HTTP Host

Payment Method

* Billing First Name
* Billing Last Name
* Address Line 1
* City
* Region ID
* Postal Code
* Country ID

Parameters

basketId. ID of the basket.
customerId. ID of the customer.
billingAddressId. ID of billing address.
shippingAddressId. ID of the shipping address.
shippingMethodId. ID of the shipping method.
orderPayment. PaymentMethod object.
specialInstructions. Special instructions.
httpHost. Host URL.

Returns

Placed OrderData.

.aspx code snippet

<span>Dimensions</span>
<ol class="formFields">                                            
    <li class="clearfix">
        <ektronUI:Label ID="uxBasketIdLabel" AssociatedControlID="uxBasketId" CssClass="span-3 last"
            runat="server" Text="* Basket Id :" />
        <ektronUI:TextField ID="uxBasketId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCustomerIdLabel" AssociatedControlID="uxCustomerId" CssClass="span-3 last"
            runat="server" Text="* Customer Id :" />
        <ektronUI:TextField ID="uxCustomerId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxBillingAddressIdLagel" AssociatedControlID="uxBillingAddressId" CssClass="span-3 last"
            runat="server" Text="* Billing AddressId:" />
        <ektronUI:TextField ID="uxBillingAddressId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingAddressIdLabel" AssociatedControlID="uxShippingAddressId" CssClass="span-3 last"
            runat="server" Text="* Shipping AddressId:" />
        <ektronUI:TextField ID="uxShippingAddressId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxShippingMethodIdLabel" AssociatedControlID="uxShippingMethodId" CssClass="span-3 last"
            runat="server" Text="* Shipping MethodId :" />
        <ektronUI:TextField ID="uxShippingMethodId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
        <li class="clearfix">
            <ektronUI:Label ID="uxSpecialInstructionLabel" AssociatedControlID="uxSpecialInstruction" CssClass="span-3 last" runat="server" Text=" SpecialInstruction:" />
            <ektronUI:TextField ID="uxSpecialInstruction" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
        </li>                                                                                    
        <li class="clearfix">
            <ektronUI:Label ID="uxHttpHostLabel" AssociatedControlID="uxHttpHost" CssClass="span-3 last" runat="server" Text=" Http Host :" />
            <ektronUI:TextField ID="uxHttpHost" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
        </li>                                                                                                        
    <li class="clearfix"><b>Payment Method</b></li> 
    <li class="clearfix">
        <ektronUI:Label ID="uxBillingFirstNameLabel" AssociatedControlID="uxBillingFirstName" CssClass="span-3 last"
            runat="server" Text="* Billing FirstName :" />
        <ektronUI:TextField ID="uxBillingFirstName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>                                                                                                                                    
    <li class="clearfix">
        <ektronUI:Label ID="uxBillingLastNameLabel" AssociatedControlID="uxBillingLastName" CssClass="span-3 last" runat="server" Text="* Billing LastName:" />
        <ektronUI:TextField  ID="uxBillingLastName" 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">
            <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
            <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
        </li>                                                              
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {            
            Ektron.Cms.Framework.Commerce.OrderManager OrderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            RegionManager regionManager = new RegionManager();
            CountryManager countryManager = new CountryManager();
            OrderData OrderData = null;

            long regionId = long.Parse(uxRegionId.Text);
            int countryId = int.Parse(uxCountryId.Text);
            long basketId=long.Parse(uxBasketId.Text);
            long customerId=long.Parse(uxCustomerId.Text);
            long billingAddressId=long.Parse(uxBillingAddressId.Text);
            long shippingAddressId=long.Parse(uxShippingAddressId.Text);
            long shippingMethodId=long.Parse(uxShippingMethodId.Text);
            
            RegionData regionData = regionManager.GetItem(regionId);
            CountryData countryData = countryManager.GetItem(countryId);            
            AddressData addressData = new AddressData()
            {
              
                AddressLine1 = uxAddressLine1.Text,
                City = uxCity.Text,
                PostalCode = uxPostalCode.Text,
                Region = regionData,
                Country = countryData,                 
            };
            PaymentMethod paymentMethod = new PaymentMethod()
            {
                BillingAddress = addressData,
                BillingFirstName = uxBillingFirstName.Text,
                BillingLastName = uxBillingLastName.Text
            };
            OrderData returnOrderData = OrderManager.PlaceOrder(basketId, customerId, billingAddressId, shippingAddressId, shippingMethodId, paymentMethod, uxSpecialInstruction.Text, uxHttpHost.Text); 
            if(returnOrderData.Id>0)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Order is placed with Id " + OrderData.Id, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Order is not placed", Message.DisplayModes.Warning );
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

SetFraud. Marks an order as fraudulent.

SetFraud

SetFraud(System.Int64)

Marks an order as fraudulent.

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

* Order ID

Parameters

orderId. ID of the order.

.aspx code snippet

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

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.OrderManager orderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            long orderId = long.Parse(uxOrderId.Text);            
            OrderData orderData = orderManager.GetItem(orderId);
            if (orderData != null && orderData.Id > 0)
            {
                orderManager.SetFraud(orderId);
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " is set as fraud.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " is not exists.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

SetHold. Sets an order to OnHold.

SetHold

SetHold(System.Int64)

Sets an order to OnHold.

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

* Order ID

Parameters

orderId. ID of the order.

.aspx code snippet

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

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.OrderManager orderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            long orderId = long.Parse(uxOrderId.Text);            
            OrderData orderData = orderManager.GetItem(orderId);
            if (orderData != null && orderData.Id > 0)
            {
                orderManager.SetHold(orderId);
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " is set to hold.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " is not exists.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

SetStatus. Sets the status of an order.

SetStatus

SetStatus(System.Int64,Ektron.Cms.Common.EkEnumeration.OrderStatus)

Sets the status of an 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

* Order ID
Order Status

Parameters

orderId. ID of the order.
status. Change the order to the specified status.

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxOrderIdLabel" AssociatedControlID="uxOrderId" CssClass="span-3 last" runat="server" Text="* Order Id:" />
        <ektronUI:TextField  ID="uxOrderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>   
     <li class="clearfix">
        <ektronUI:Label ID="uxOrderStatusLabel" AssociatedControlID="uxOrderStatus" CssClass="span-4 last" runat="server" Text="Order Status:" />
        <asp:DropDownList ID="uxOrderStatus" runat="server">
            <asp:ListItem value="0">Received</asp:ListItem>
            <asp:ListItem value="1">InProcess</asp:ListItem>
            <asp:ListItem value="2">Shipped </asp:ListItem>
            <asp:ListItem value="3">Completed </asp:ListItem>
            <asp:ListItem value="4">Cancelled </asp:ListItem>
            <asp:ListItem value="5">OnHold </asp:ListItem>
            <asp:ListItem value="6">Fraud </asp:ListItem>
        </asp:DropDownList>
    </li>
     <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="SetStatus"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.OrderManager orderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            long orderId = long.Parse(uxOrderId.Text);
            Ektron.Cms.Common.EkEnumeration.OrderStatus orderStatus = (Ektron.Cms.Common.EkEnumeration.OrderStatus)int.Parse(uxOrderStatus.SelectedValue);  
            OrderData orderData = orderManager.GetItem(orderId);
            if (orderData != null && orderData.Id > 0)
            {
                orderManager.SetStatus(orderId,orderStatus);
                MessageUtilities.UpdateMessage(uxMessage, "Order " + orderId + " status has been set to "+ orderStatus +".", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " is not exists.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

SetTrackingNumber. Sets the tracking number for an order part.

SetTrackingNumber

SetTrackingNumber(System.Int64,System.String,System.Boolean)

Sets the tracking number for an order part.

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

* Order ID
* Tracking Number
Mark As Shipped

Parameters

orderId. ID of order to set tracking number.
trackingNumber. The tracking number
markAsShipped. Mark the item as shipped.

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxOrderIdLabel" AssociatedControlID="uxOrderId" CssClass="span-3 last" runat="server" Text="* Order Id:" />
        <ektronUI:TextField  ID="uxOrderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>   
     <li class="clearfix">
        <ektronUI:Label ID="uxOrderTrackingNumberLabel" AssociatedControlID="uxOrderTrackingNumber" CssClass="span-3 last" runat="server" Text="* Tracking Number:" />
        <ektronUI:TextField  ID="uxOrderTrackingNumber" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>   
     <li class="clearfix">
        <ektronUI:Label ID="uxMarkedasShippedLabel" AssociatedControlID="uxMarkedasShipped" CssClass="span-3 last" runat="server" Text=" MarkAsShipped:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxMarkedasShipped" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>   
     <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="SetTrackingNumber"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            bool IsMarked = false;
            Ektron.Cms.Framework.Commerce.OrderManager orderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            long orderId = long.Parse(uxOrderId.Text);
            if (uxMarkedasShipped.Checked)
            {
                IsMarked = true;
            }
            OrderData orderData = orderManager.GetItem(orderId);
            if(orderData != null )
            {
                 orderManager.SetTrackingNumber(orderId, uxOrderTrackingNumber.Text, IsMarked);            
                 MessageUtilities.UpdateMessage(uxMessage, "Tracking Number is set to the order " + orderId , Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " does not exists.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

Update. Update the existing order.

Update

Update(Ektron.Cms.Commerce.OrderData)

Update the existing 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

* Order ID
* Billing ID
* Customer ID
* Currency ID
Order Status
Client IP
HTTP Host

Parameters

orderData. OrderData object.

.aspx code snippet

<span>Dimensions</span>
<ol class="formFields">                                            
 
    <li class="clearfix">
        <ektronUI:Label ID="uxOrderIdLabel" AssociatedControlID="uxOrderId" CssClass="span-3 last"
            runat="server" Text="* Order Id :" />
        <ektronUI:TextField ID="uxOrderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>                    
    <li class="clearfix">
        <ektronUI:Label ID="uxBillingIdLabel" AssociatedControlID="uxBillingId" CssClass="span-3 last"
            runat="server" Text="* Billing Id :" />
        <ektronUI:TextField ID="uxBillingId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCustomerIdLabel" AssociatedControlID="uxCustomerId" CssClass="span-3 last"
            runat="server" Text="* Customer Id :" />
        <ektronUI:TextField ID="uxCustomerId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCurrencyIdLagel" AssociatedControlID="uxCurrencyId" CssClass="span-3 last"
            runat="server" Text="* Currency Id :" />
        <ektronUI:TextField ID="uxCurrencyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxOrderStatusLabel" AssociatedControlID="uxOrderStatus" CssClass="span-3 last" runat="server" Text="Order Status:" />
        <asp:DropDownList ID="uxOrderStatus" runat="server">
            <asp:ListItem Value ="0">Received</asp:ListItem>
            <asp:ListItem Value ="1">InProcess</asp:ListItem>
            <asp:ListItem Value ="2">Shipped</asp:ListItem>
            <asp:ListItem Value ="3">Completed</asp:ListItem>
            <asp:ListItem Value ="4">Cancelled</asp:ListItem>
            <asp:ListItem Value ="5">OnHold</asp:ListItem>
            <asp:ListItem Value ="6">Fraud</asp:ListItem>
        </asp:DropDownList>
    </li>                
    <li class="clearfix">
        <ektronUI:Label ID="uxClientIpLabel" AssociatedControlID="uxClientIp" CssClass="span-3 last"
            runat="server" Text=" Client IP :" />
        <ektronUI:TextField ID="uxClientIp" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxHttpHostLabel" AssociatedControlID="uxHttpHost" CssClass="span-3 last"
            runat="server" Text=" HttpHost :" />
        <ektronUI:TextField ID="uxHttpHost" 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
        {
            long orderId = long.Parse(uxOrderId.Text);
            int currencyId = int.Parse(uxCurrencyId.Text);
            long customerId = long.Parse(uxCustomerId.Text);
            long billingId = long.Parse(uxBillingId.Text);
            Ektron.Cms.Common.EkEnumeration.OrderStatus status = (Ektron.Cms.Common.EkEnumeration.OrderStatus)int.Parse(uxOrderStatus.Text);

            Ektron.Cms.Framework.Commerce.OrderManager orderManager = new Ektron.Cms.Framework.Commerce.OrderManager();
            OrderData orderData = orderManager.GetItem(orderId);
            if (orderData != null)
            {
                orderData.BillingAddressId = billingId;
                orderData.Customer.Id = customerId;
                orderData.Currency.Id = currencyId;
                orderData.Status = status;
                orderData.ClientIP = uxClientIp.Text;
                orderData.HttpHost = uxHttpHost.Text;
                orderData=orderManager.Update(orderData);

                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " has been updated.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Order with Id " + orderId + " does not exists.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

OrderManager

Namespace

Constructors

Properties

Methods

ApplyCoupon

Authenticated users

Fields

Parameters

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

Capture (order)

Authenticated users

Fields

Parameters

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

Capture (payment)

Authenticated users

Fields

Parameters

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

Delete

Authenticated users

Fields

Parameters

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

GetItem

Authenticated users

Fields

Parameters

Returns

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

GetList

Authenticated users

Fields

Parameters

Returns

Criteria use

Criteria objects

Constructor(property, orderbyDirection)

AddFilter(property, operator, value)

LogicalOperation Condition

List<CriteriaFilterGroup> FilterGroups

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

GetOrderPaymentList

Authenticated users

Fields

Parameters

Returns

Criteria use

Criteria objects

Constructor(property, orderbyDirection)

AddFilter(property, operator, value)

LogicalOperation Condition

List<CriteriaFilterGroup> FilterGroups

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

GetStatus

Authenticated users

Fields

Parameters

Returns

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

PlaceOrder

Authenticated users

Fields