InventoryManager

The class manages inventory in the CMS.

Namespace

Ektron.Cms.Framework.Commerce.InventoryManager

Constructors

  • InventoryManager()
  • InventoryManager(ApiAccessMode).

Properties

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

Methods

Add

Add(Ektron.Cms.Commerce.InventoryData)

Adds the inventory data to catalog entry item.

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

  • * Entry ID
  • * Units in Stock
  • * Reorder Level
  • Disable Inventory

Parameters

  • inventoryData. Inventory data object to be added.

Returns

InventoryData object.

.aspx code snippet

<ol class="formFields">                                                                   
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryidLabel" AssociatedControlID="uxEntryId" CssClass="span-4 last" runat="server" Text="* Entry Id:" />
        <ektronUI:TextField  ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>    
    <li class="clearfix">
        <ektronUI:Label ID="uxQuantityLabel" AssociatedControlID="uxUnitsInStock" CssClass="span-4 last" runat="server" Text="* Units In Stock:" />
        <ektronUI:TextField  ID="uxUnitsInStock" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxReorderLevelLabel" AssociatedControlID="uxReorderLevel" CssClass="span-4 last" runat="server" Text="* Reorder Level:" />
        <ektronUI:TextField  ID="uxReorderLevel" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>    
    <li class="clearfix">
        <ektronUI:Label ID="uxInventoryDissabledLable" AssociatedControlID="uxInventoryDissabled" CssClass="span-4 last" runat="server" Text="Disable Inventory:" />
        <asp:checkbox ID="uxInventoryDissabled"  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 Ektron.Site.Developer;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            
            Ektron.Cms.Framework.Commerce.InventoryManager Inventorymanager = new Ektron.Cms.Framework.Commerce.InventoryManager();

            Ektron.Cms.Commerce.InventoryData inventorydata = new Ektron.Cms.Commerce.InventoryData();
            inventorydata.EntryId = long.Parse(uxEntryId.Text);            
            inventorydata.ReorderLevel = int.Parse(uxReorderLevel.Text);
            inventorydata.UnitsInStock = int.Parse(uxUnitsInStock.Text);            
            inventorydata.DisableEntryInventoryManagement = (Boolean)uxInventoryDissabled.Checked;

            inventorydata = Inventorymanager.Add(inventorydata);
            MessageUtilities.UpdateMessage(uxMessage, "Inventory data is added successfully ", Message.DisplayModes.Success);            
            uxPageMultiView.SetActiveView(uxViewMessage);                        

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

DecreaseStockLevel

DecreaseStockLevel(System.Int64,System.Int32)

To decrease the stock level based on the entry ID and quantity.

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

  • * Entry ID
  • * Quantity

Parameters

  • entryId. ID of the catalog entry.
  • quantity. Quantity of the catalog product.

.aspx code snippet

<ol class="formFields">                                                                   
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryidLabel" AssociatedControlID="uxEntryId" CssClass="span-3 last" runat="server" Text="* Entry Id:" />
        <ektronUI:TextField  ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxQuantityLabel" AssociatedControlID="uxquantity" CssClass="span-3 last" runat="server" Text="* Quantity:" />
        <ektronUI:TextField  ID="uxquantity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>                                                                                   
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="DecreaseStockLevel"></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 Ektron.Site.Developer;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.InventoryManager Inventorymanager = new Ektron.Cms.Framework.Commerce.InventoryManager();
            long EntryId = long.Parse(uxEntryId.Text);
            int Quantity = int.Parse(uxquantity.Text);
            Inventorymanager.DecreaseStockLevel(EntryId, Quantity);

            MessageUtilities.UpdateMessage(uxMessage, "Stock level decreased for entry Id " + EntryId, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);                        

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

GetItem

GetItem(System.Int64)

Retrieves the inventory data by its entry 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

  • * Entry ID

Parameters

  • entryId. ID of the catalog entry.

Returns

InventoryData object.

.aspx code snippet

<ol class="formFields">                                                                   
        <li class="clearfix">
        <ektronUI:Label ID="uxEntryidLabel" AssociatedControlID="uxEntryId" CssClass="span-3 last" runat="server" Text="* Entry Id:" />
        <ektronUI:TextField  ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>                                                                                  
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetItem"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Message ID="Message1" DisplayMode="Information" Visible="false" runat="server" />
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUnitsisStock" runat="server"></asp:Literal>
    </li> 
    <li class="clearfix">
        <asp:Literal ID="uxUnitsonOrder" runat="server"></asp:Literal>
    </li> 
    <li class="clearfix">
        <asp:Literal ID="uxReorderLevel" runat="server"></asp:Literal>
    </li> 
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using Ektron.Site.Developer;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.InventoryManager Inventorymanager = new Ektron.Cms.Framework.Commerce.InventoryManager();
            long EntryId = long.Parse(uxEntryId.Text); 
            Ektron.Cms.Commerce.InventoryData inventorydata ;
            inventorydata = Inventorymanager.GetItem(EntryId);

            if (inventorydata != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Inventory Details with Id " + inventorydata.EntryId, Message.DisplayModes.Success);
                uxId.Text = "EntryId : " + inventorydata.EntryId.ToString();
                uxUnitsisStock.Text = "Unit In Stock : " + inventorydata.UnitsInStock.ToString();
                uxUnitsonOrder.Text = "Units On Order : " + inventorydata.UnitsOnOrder.ToString();
                uxReorderLevel.Text = "Reorder level : " + inventorydata.ReorderLevel.ToString();

            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "No inventory data is exists to the entry " + EntryId, 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.InventoryCriteria)

Retrieves the list of inventorydata 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

  • Inventory Property
  • * Object Value

Parameters

  • criteria. Criteria by which to filter and sort inventory.

Returns

List of InventoryData objects that matches the criteria.

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="uxInventoryPropertyLabel" AssociatedControlID="uxInventoryProperty" CssClass="span-4 last" runat="server" Text="InventoryProperty:" />
        <asp:DropDownList ID="uxInventoryProperty" runat="server">
            <asp:ListItem>EntryId</asp:ListItem>
            <asp:ListItem>EntryType</asp:ListItem>
            <asp:ListItem>UnitsInStock</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="GetList"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
 
<asp:ListView ID="uxCouponListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                       EntryTitle
                    </th>
                    <th>
                        UnitsInStock
                    </th>
                    <th>
                        UnitsOnOrder
                    </th>
                    <th>
                        ReorderLevel
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("EntryTitle")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UnitsInStock")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UnitsOnOrder")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ReorderLevel")%>
            </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;
            InventoryCriteria criteria = new InventoryCriteria();

            if (uxInventoryProperty.SelectedItem.Text == "EntryId")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(InventoryProperty.EntryId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxInventoryProperty.SelectedItem.Text == "UnitsInStock")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(InventoryProperty.UnitsInStock, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(InventoryProperty.UnitsOnOrder, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            Ektron.Cms.Framework.Commerce.InventoryManager inventoryManger = new Ektron.Cms.Framework.Commerce.InventoryManager();
            List<InventoryData> inventoryList = inventoryManger.GetList(criteria);

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

            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetReorderLevel

GetReorderLevel(System.Int64)

Get the reorder level based on the entry 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

  • * Entry ID

Parameters

  • entryId. ID of the catalog entry.

Returns

Returns the reorder level of entry.

.aspx code snippet

<ol class="formFields">                                                                   
        <li class="clearfix">
        <ektronUI:Label ID="uxEntryidLabel" AssociatedControlID="uxEntryId" CssClass="span-3 last" runat="server" Text="* Entry Id:" />
        <ektronUI:TextField  ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>                                                                                  
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get ReOrderLevel"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Message ID="Message1" DisplayMode="Information" Visible="false" runat="server" />
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxReorderLevel" runat="server"></asp:Literal>
    </li> 
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using Ektron.Site.Developer;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.InventoryManager Inventorymanager = new Ektron.Cms.Framework.Commerce.InventoryManager();
            long EntryId = long.Parse(uxEntryId.Text);
            long reorderlevel = 0;
            reorderlevel = Inventorymanager.GetReorderLevel(EntryId);

            MessageUtilities.UpdateMessage(uxMessage, "Re-Order Level for the entry Id " + EntryId, Message.DisplayModes.Success);
            uxId.Text = "EntryId : " + EntryId.ToString();
            uxReorderLevel.Text = "Re-Order Level : " + reorderlevel.ToString();
            uxPageMultiView.SetActiveView(uxViewMessage);                        

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

GetUnitsInStock

GetUnitsInStock(System.Int64)

Get the units in stock based on entry 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

  • * Entry ID

Parameters

  • entryId. ID of the catalog entry.

Returns

Returns the number of units in stock.

.aspx code snippet

<ol class="formFields">                                                                   
        <li class="clearfix">
        <ektronUI:Label ID="uxEntryidLabel" AssociatedControlID="uxEntryId" CssClass="span-3 last" runat="server" Text="* Entry Id:" />
        <ektronUI:TextField  ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>                                                                                  
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get UnitsInStock"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Message ID="Message1" DisplayMode="Information" Visible="false" runat="server" />
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUnitsInStock" runat="server"></asp:Literal>
    </li> 
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using Ektron.Site.Developer;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.InventoryManager Inventorymanager = new Ektron.Cms.Framework.Commerce.InventoryManager();
            long EntryId = long.Parse(uxEntryId.Text);
            long unitsinStock = 0;
            unitsinStock = Inventorymanager.GetUnitsInStock(EntryId);
            MessageUtilities.UpdateMessage(uxMessage, "Units in stock by Entry Id " + EntryId, Message.DisplayModes.Success);
            uxId.Text = "EntryId : " + EntryId.ToString();
            uxUnitsInStock.Text = "Unit In Stock : " + unitsinStock.ToString();
            uxPageMultiView.SetActiveView(uxViewMessage);                        

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

GetUnitsOnOrder

GetUnitsOnOrder(System.Int64)

Get the units on order based on entry 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

  • * Entry ID

Parameters

  • entryId. ID of the catalog entry.

Returns

Returns the number of units on order.

.aspx code snippet

<ol class="formFields">                                                                   
        <li class="clearfix">
        <ektronUI:Label ID="uxEntryidLabel" AssociatedControlID="uxEntryId" CssClass="span-3 last" runat="server" Text="* Entry Id:" />
        <ektronUI:TextField  ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>                                                                                  
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get UnitsOnOrder"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Message ID="Message1" DisplayMode="Information" Visible="false" runat="server" />
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUnitsonOrder" runat="server"></asp:Literal>
    </li> 
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using Ektron.Site.Developer;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.InventoryManager Inventorymanager = new Ektron.Cms.Framework.Commerce.InventoryManager();
            long EntryId = long.Parse(uxEntryId.Text);
            long unitsOnOrder = 0;
            unitsOnOrder = Inventorymanager.GetUnitsOnOrder(EntryId);
            MessageUtilities.UpdateMessage(uxMessage, "Units on Order for the Entry Id " + EntryId, Message.DisplayModes.Success);
            uxId.Text = "EntryId : " + EntryId.ToString();
            uxUnitsonOrder.Text = "Unit On Order : " + unitsOnOrder.ToString();
            uxPageMultiView.SetActiveView(uxViewMessage);                        

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

IncreaseStockLevel

IncreaseStockLevel(System.Int64,System.Int32)

To increase the Stock level based on the entryId and quantity.

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

  • * Entry ID
  • * Quantity

Parameters

  • entryId. ID of the catalog entry.
  • quantity. Quantity of the catalog product.

.aspx code snippet

<ol class="formFields">                                                                   
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryidLabel" AssociatedControlID="uxEntryId" CssClass="span-3 last" runat="server" Text="* Entry Id:" />
        <ektronUI:TextField  ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxQuantityLabel" AssociatedControlID="uxquantity" CssClass="span-3 last" runat="server" Text="* Quantity:" />
        <ektronUI:TextField  ID="uxquantity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>                                                                                   
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="IncreaseStockLevel"></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 Ektron.Site.Developer;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.InventoryManager Inventorymanager = new Ektron.Cms.Framework.Commerce.InventoryManager();
            long EntryId = long.Parse(uxEntryId.Text);
            int Quantity = int.Parse(uxquantity.Text);
            Inventorymanager.IncreaseStockLevel(EntryId, Quantity);

            MessageUtilities.UpdateMessage(uxMessage, "Stock level increased for entry Id " + EntryId, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);                        

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

IsItemAvailable

IsItemAvailable(System.Int64,System.Int32,System.Boolean)

Checks whether the number of items are available in the stock.

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

  • * Entry ID
  • * Quantity
  • Disable Inventory

Parameters

  • entryId. ID of the catalog entry.
  • quantity. Quantity of the catalog product.
  • checkInventoryDisabled. True if the inventory is disabled; otherwise false.

Returns

Returns true if the stock matches the quantity; otherwise false.

.aspx code snippet

<ol class="formFields">                                                                   
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryidLabel" AssociatedControlID="uxEntryId" CssClass="span-3 last" runat="server" Text="* Entry Id:" />
        <ektronUI:TextField  ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxQuantityLabel" AssociatedControlID="uxquantity" CssClass="span-3 last" runat="server" Text="* Entry Id:" />
        <ektronUI:TextField  ID="uxquantity" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxInventoryDissabledLable" AssociatedControlID="uxInventoryDissabled" CssClass="span-3 last" runat="server" Text="* Disable Inventory:" />
        <asp:checkbox  ID="uxInventoryDissabled"  runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>  
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="IsItemAvailable"></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 Ektron.Site.Developer;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            Ektron.Cms.Framework.Commerce.InventoryManager Inventorymanager = new Ektron.Cms.Framework.Commerce.InventoryManager();
            long EntryId = long.Parse(uxEntryId.Text);
            int Quantity = int.Parse(uxquantity.Text);
			Boolean Isinventorydissabled = (Boolean)uxInventoryDissabled.Checked;
            Boolean isItemavailable = false;
            isItemavailable = Inventorymanager.IsItemAvailable(EntryId, Quantity, Isinventorydissabled);
            if (isItemavailable)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Item is available for the entry Id " + EntryId, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Item not available for the entry Id " + EntryId, Message.DisplayModes.Information);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);                        

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

Update

Update(Ektron.Cms.Commerce.InventoryData)

Updates the inventory data to catalog entry item based on its entry 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

  • * Entry ID
  • * Units in Stock
  • * Reorder Level

Parameters

  • inventoryData. Inventory data object to be added.

Returns

InventoryData object.

.aspx code snippet

<ol class="formFields">                                                                   
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryidLabel" AssociatedControlID="uxEntryId" CssClass="span-4 last" runat="server" Text="* Entry Id:" />
        <ektronUI:TextField  ID="uxEntryId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>    
    <li class="clearfix">
        <ektronUI:Label ID="uxQuantityLabel" AssociatedControlID="uxUnitsInStock" CssClass="span-4 last" runat="server" Text="* Units In Stock:" />
        <ektronUI:TextField  ID="uxUnitsInStock" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxReorderLevelLabel" AssociatedControlID="uxReorderLevel" CssClass="span-4 last" runat="server" Text="* Reorder Level:" />
        <ektronUI:TextField  ID="uxReorderLevel" 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 Ektron.Site.Developer;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {            
            Ektron.Cms.Framework.Commerce.InventoryManager inventoryManager = new Ektron.Cms.Framework.Commerce.InventoryManager();
            long entryId=long.Parse(uxEntryId.Text);
            InventoryData inventoryData = inventoryManager.GetItem(entryId);
            if (inventoryData != null)
            {
                inventoryData.ReorderLevel = int.Parse(uxReorderLevel.Text);
                inventoryData.UnitsInStock = int.Parse(uxUnitsInStock.Text);

                inventoryData = inventoryManager.Update(inventoryData);
                MessageUtilities.UpdateMessage(uxMessage, "Inventory data updated successfully ", Message.DisplayModes.Success);
                uxPageMultiView.SetActiveView(uxViewMessage);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Invalid entry Id has been passed", Message.DisplayModes.Error);
                uxPageMultiView.SetActiveView(uxViewMessage);
            }
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

Data Classes

InventoryCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • InventoryCriteria()
    public InventoryCriteria()
  • InventoryCriteria(Ektron.Cms.Commerce.InventoryProperty, EkEnumeration.OrderByDirection)
    public InventoryCriteria(Ektron.Cms.Commerce.InventoryProperty orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the InventoryProperty are:

    • EntryId
    • EntryTitle
    • EntryType
    • ReorderLevel
    • UnitsInStock
    • UnitsOnOrder

InventoryData

Namespace

Ektron.Cms.Commerce

Properties

  • DisableEntryInventoryManagement. Gets or sets the entry disable inventory management flag.
    public bool DisableEntryInventoryManagement { set; get; }
  • EntryId. Gets or sets the ID of the catalog entry (product) that this inventory data represents.
    public long EntryId { set; get; }
  • EntryTitle. Gets or sets the Title of the catalog entry(product) that this inventory data represents.
    public string EntryTitle { set; get; }
  • EntryType. Gets or sets the Type of the catalog entry(product) that this inventory data represents.
    public EkEnumeration.CatalogEntryType EntryType { set; get; }
  • InventoryData()
    public InventoryData()
  • InventoryData(long, int, int, int)
    public InventoryData(long entryId, int unitsInStock, int unitsOnOrder, int reOrderlevel)
  • ReorderLevel. Gets or sets the inventory level at which stock should be reordered.
    public int ReorderLevel { set; get; }
  • UnitsInStock. Gets or sets the the number of units currently in stock for the product.
    public int UnitsInStock { set; get; }
  • UnitsOnOrder. Gets or sets The number of units currently on order for this product. This is the number of units that the store has ordered to replenish inventory and NOT the number of units that are currently on order by customers.
    public int UnitsOnOrder { set; get; }