WarehouseManager

The class manages commerce warehouses in the CMS.

Namespace

Ektron.Cms.Framework.Commerce.WarehouseManager

Constructors

  • WarehouseManager()
  • WarehouseManager(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.WarehouseData)

Adds a warehouse to the CMS.The WarehouseData.Id property is populated with the new Warehouse 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

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

Parameters

  • warehouseData. Warehouse data object to add.

Returns

WarehouseData object added.

.aspx code snippet

<span>Dimensions</span>
<ol class="formFields">                                            
    <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:Label ID="uxWarehouseNameLabel" AssociatedControlID="uxWarehouseName" CssClass="span-3 last" runat="server" Text="* Name:" />
        <ektronUI:TextField  ID="uxWarehouseName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>           
    <li class="clearfix">
        <ektronUI:Label ID="uxWarehouseDefaultLabel" AssociatedControlID="uxWarehouseDefault" CssClass="span-3 last" runat="server" Text=" IsDefaultWarehouse:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxWarehouseDefault" 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
        {
            bool IsDefault = false;
            WarehouseManager warehouseManager = new WarehouseManager();
            RegionManager regionManager = new RegionManager();
            CountryManager countryManager = new CountryManager();
            WarehouseData warehouseData = null;

            long regionId = long.Parse(uxRegionId.Text);
            int countryId = int.Parse(uxCountryId.Text);
            if (uxWarehouseDefault.Checked)
            {
                IsDefault = true;
            }
            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
            };
            warehouseData = new WarehouseData()
            {
                Address = addressData,
                IsDefaultWarehouse = IsDefault,
                Name = uxWarehouseName.Text
            };
            warehouseManager.Add(warehouseData);
                                                                   
            if (warehouseData.Id > 0)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Warehouse is added with Id " + warehouseData.Id, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Warehouse is not added", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

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

Delete

Delete(System.Int64)

Deletes the warehouse from 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

  • * Warehouse ID

Parameters

  • warehouseId. ID of the warehouse to be deleted.

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxWarehouseIdLabel" AssociatedControlID="uxWarehouseId" CssClass="span-3 last" runat="server" Text="* Warehouse Id:" />
        <ektronUI:TextField  ID="uxWarehouseId" 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
        {
            WarehouseManager warehouseManager = new WarehouseManager();
            long warehouseId = long.Parse(uxWarehouseId.Text);            
            WarehouseData WarehouseData = warehouseManager.GetItem(warehouseId);
            if (WarehouseData != null && WarehouseData.Id > 0)
            {
                warehouseManager.Delete(warehouseId);
                MessageUtilities.UpdateMessage(uxMessage, "Warehouse with Id " + warehouseId + " is deleted.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Warehouse with Id " + warehouseId + " does not exists.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

GetDefault

GetDefault()

Gets the default warehouse.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Returns

WarehouseData object.

.aspx code snippet

<ol class="formFields">         
     <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetDefault"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-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="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsDefault" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxAddress" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCity" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxPostalCode" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCRegionName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCountryName" 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
        {
            WarehouseManager warehouseManager = new WarehouseManager();
            WarehouseData WarehouseData = warehouseManager.GetDefault();
            if (WarehouseData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for default warehouse with ID " + WarehouseData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxName.Text  = "Name : " + WarehouseData.Name;
                uxIsDefault.Text  = "IsDefault : " + WarehouseData.IsDefaultWarehouse;
                uxAddress.Text = "Address : " + WarehouseData.Address.AddressLine1;
                uxCity.Text = "City : " + WarehouseData.Address.City;
                uxPostalCode.Text = "Postal Code : " + WarehouseData.Address.PostalCode;
                uxCRegionName.Text = "Region Name : " + WarehouseData.Address.Region.Name;
                uxCountryName.Text = "Country Name : " + WarehouseData.Address.Country.Name;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Default warehouse is not exists.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

GetItem

GetItem(System.Int64)

Gets the single warehouse data object by warehouse 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

  • * Warehouse ID

Parameters

  • warehouseId. ID of the warehouse to be retrieved.

Returns

WarehouseData object.

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxWarehouseIdLabel" AssociatedControlID="uxWarehouseId" CssClass="span-3 last" runat="server" Text="* Warehouse Id:" />
        <ektronUI:TextField  ID="uxWarehouseId" 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="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsDefault" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxAddress" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCity" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxPostalCode" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCRegionName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCountryName" 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
        {
            WarehouseManager warehouseManager = new WarehouseManager();
            long warehouseId = long.Parse(uxWarehouseId.Text);            
            WarehouseData WarehouseData = warehouseManager.GetItem(warehouseId);
            if (WarehouseData != null && WarehouseData.Id > 0)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for Warehouse with ID " + WarehouseData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxName.Text  = "Name : " + WarehouseData.Name;
                uxIsDefault.Text  = "IsDefault : " + WarehouseData.IsDefaultWarehouse;
                uxAddress.Text = "Address : " + WarehouseData.Address.AddressLine1;
                uxCity.Text = "City : " + WarehouseData.Address.City;
                uxPostalCode.Text = "Postal Code : " + WarehouseData.Address.PostalCode;
                uxCRegionName.Text = "Region Name : " + WarehouseData.Address.Region.Name;
                uxCountryName.Text = "Country Name : " + WarehouseData.Address.Country.Name;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Warehouse with Id " + warehouseId + " does not exists.", Message.DisplayModes.Warning);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

GetList

GetList(Ektron.Cms.Commerce.WarehouseCriteria)

Returns the list of warehouse data object by 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

  • Warehouse Property
  • * Object Value

Parameters

  • criteria. Criteria by which to filter warehouse being retrieved.

Returns

List of WarehouseCriteria filters.

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="uxWarehousePropertyLabel" AssociatedControlID="uxWarehouseProperty" CssClass="span-4 last" runat="server" Text="Warehouse Property:" />
        <asp:DropDownList ID="uxWarehouseProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Name</asp:ListItem>
            <asp:ListItem>AddressId </asp:ListItem>            
            <asp:ListItem>City </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="uxWarehouseListView" 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>
                       Name
                    </th>
                    <th>
                       Address
                    </th>
                    <th>
                        City
                    </th>
                    <th>
                       Postal Code
                    </th>
                    <th>
                       Region Name
                    </th>
                    <th>
                       Country Name
                    </th>                    
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Address.AddressLine1")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Address.City")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Address.PostalCode")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Address.Region.Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Address.Country.Name")%>
            </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;
            WarehouseCriteria criteria = new WarehouseCriteria();

            if (uxWarehouseProperty.SelectedItem.Text == "Id")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(WarehouseProperty.Id, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxWarehouseProperty.SelectedItem.Text == "Name")
            {
                Objectvalue =uxObjectValue.Text;
                criteria.AddFilter(WarehouseProperty.Name , Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (uxWarehouseProperty.SelectedItem.Text == "AddressId")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                criteria.AddFilter(WarehouseProperty.AddressId, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue =uxObjectValue.Text;
                criteria.AddFilter(WarehouseProperty.City , Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            WarehouseManager warehouseManger = new WarehouseManager();
            List<WarehouseData> warehouseList = warehouseManger.GetList(criteria);

            uxWarehouseListView.Visible = true;
            uxWarehouseListView.DataSource = warehouseList;
            uxWarehouseListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

SetDefault

SetDefault(System.Int64)

Marks the existing warehouse as default warehouse.

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

  • * Warehouse ID

Parameters

  • warehouseId. ID of the warehouse to become default warehouse.

.aspx code snippet

<ol class="formFields">   
     <li class="clearfix">
        <ektronUI:Label ID="uxWarehouseIdLabel" AssociatedControlID="uxWarehouseId" CssClass="span-3 last" runat="server" Text="* Warehouse Id:" />
        <ektronUI:TextField  ID="uxWarehouseId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>   
     <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="SetDefault"></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
        {
            WarehouseManager warehouseManager = new WarehouseManager();
            long warehouseId = long.Parse(uxWarehouseId.Text);            
            WarehouseData WarehouseData = warehouseManager.GetItem(warehouseId);
            if (WarehouseData != null && WarehouseData.Id > 0)
            {
                warehouseManager.SetDefault(warehouseId);
                MessageUtilities.UpdateMessage(uxMessage, "Warehouse with Id " + warehouseId + " is set as default warehouse.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Warehouse with Id " + warehouseId + " 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(Ektron.Cms.Commerce.WarehouseData)

Updates the existing warehouse.

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

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

Parameters

  • warehouseData. WarehouseData object to update.

Returns

WarehouseData object updated.

.aspx code snippet

<span>Dimensions</span>
<ol class="formFields">                                            
 
    <li class="clearfix">
        <ektronUI:Label ID="uxWarehouseIdLabel" AssociatedControlID="uxWarehouseId" CssClass="span-3 last"
            runat="server" Text="* Warehouse Id :" />
        <ektronUI:TextField ID="uxWarehouseId" 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>    
        <li class="clearfix">
        <ektronUI:Label ID="uxWarehouseNameLabel" AssociatedControlID="uxWarehouseName" CssClass="span-3 last" runat="server" Text="* Name:" />
        <ektronUI:TextField  ID="uxWarehouseName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxWarehouseDefaultLabel" AssociatedControlID="uxWarehouseDefault" CssClass="span-3 last" runat="server" Text=" IsDefaultWarehouse:" />
        <ektronUI:Button DisplayMode="Checkbox"  Text="" ID="uxWarehouseDefault" 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
        {
            bool IsDefault = false;
            WarehouseManager warehouseManager = new WarehouseManager();
            RegionManager regionManager = new RegionManager();
            CountryManager countryManager = new CountryManager();            

            long regionId = long.Parse(uxRegionId.Text);
            int countryId = int.Parse(uxCountryId.Text);
            long warehouseId=long.Parse(uxWarehouseId.Text);
            if (uxWarehouseDefault.Checked)
            {
                IsDefault = true;
            }
            RegionData regionData = regionManager.GetItem(regionId);
            CountryData countryData = countryManager.GetItem(countryId);
            WarehouseData warehouseData = warehouseManager.GetItem(warehouseId);
            if (warehouseData != null)
            {
                AddressData addressData = warehouseData.Address ;
                addressData.AddressLine1 =uxAddressLine1.Text ;
                addressData.City =uxCity.Text ;
                addressData.PostalCode =uxPostalCode .Text ;
                addressData.Region =regionData ;
                addressData.Country =countryData ;
                
                warehouseData.Address=addressData ;
                warehouseData.Name =uxWarehouseName.Text ;
                warehouseData.IsDefaultWarehouse =IsDefault ;
                
                warehouseManager.Update(warehouseData);
                MessageUtilities.UpdateMessage(uxMessage, "Warehouse is updated with Id " + warehouseData.Id, Message.DisplayModes.Success);
            }                                                  
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Warehouse with Id "+ warehouseId + " does not exists.", Message.DisplayModes.Warning );
            }            
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
     }

Data Classes

WarehouseCriteria

Namespace

Ektron.Cms.Commerce

Constructors

  • WarehouseCriteria()
    public WarehouseCriteria()
  • WarehouseCriteria(Ektron.Cms.Commerce.WarehouseProperty, EkEnumeration.OrderByDirection)
    public WarehouseCriteria(Ektron.Cms.Commerce.WarehouseProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the WarehouseProperty are:

    • AddressCompanyName
    • AddressId
    • AddressLine1
    • AddressLine2
    • City
    • CounteryEnabled
    • CountryId
    • CountryLongIsoCode
    • CountryName
    • CountryShortIsoCode
    • Id
    • IsCommercial
    • IsDefault
    • IsValidated
    • Name
      phone
    • PostalCode
    • RegionAlphaCode
    • RegionEnabled
    • RegionId
    • RegionName

WarehouseData

Namespace

Ektron.Cms.Commerce

Properties

  • Address. Gets or sets the address of this Warehouse.
    public Ektron.Cms.Commerce.AddressData Address { set; get; }
  • Id. Gets or sets Id of Address.
    public long Id { set; get; }
  • IsDefaultWarehouse. Gets or sets the IsDefaultWarehouse status property for the warehouse. If true, this warehouse is the default warehouse for the system.
    public bool IsDefaultWarehouse { set; get; }
  • Name. Gets or sets the name of this Warehouse.
    public string Name { set; get; }
  • WarehouseData()
    public WarehouseData()
  • WarehouseData(string, Ektron.Cms.Commerce.AddressData)
    public WarehouseData(string warehouseName, 
  Ektron.Cms.Commerce.AddressData address)