CMS.Ecommerce

Helper methods for logging activities in CMSDesk.

Returns contact ID for particular customer.

Customer Site ID

General interface used for implementing and calculating tax of the shopping cart item.

Tax class identifier.

Tax class display name.

Tax class value.

True - tax class value is flat, False (default) - tax class value is relative.

True - tax class value is set in global main currency, False (default) - tax class value is set in site main currency. Takes effect only if tax class value is flat.

True - if customer's tax ID is supplied, the tax value for the customer is zero. False (default) - value of the tax is calculated

Tax class custom data.

Discount type.

Discount coupon

Volume discount

Discount level

Custom discount

General interface used for implementing and calculating discount of the shopping cart item.

Discount type.

Discount identifier.

Discount display name.

Discount value.

True - discount value is flat, False - discount value is relative.

True - says that discounts value is set in global main currency, False - says that discounts value is set in site main currency. Takes effect only if discount value is flat.

Number of units the discount should be applied to

Discount custom data.

Class representing custom discount which should be applied to the specified shopping cart item. It implements IItemDiscount interface.

Constructor - Creates an empty ItemDiscount object.

Constructor - Creates a new ItemDiscount object from serialized data.

Stores all the data needed to serialize or deserialize the object Describes the source and destination of a given serialized stream

Gets object data.

Type of the discount. 'Custom discount' type is set by default.

Discount unique identifier.

Discount display name which is displayed to the customers in shopping cart item price detail dialog.

Discount value. It can be either relative or flat according to the ItemDiscountIsFlat property.

True - discount value is flat, False (default) - discount value is relative.

True - discount value is set in global main currency, False (default) - discount value is set in site main currency. Takes effect only if discount value is flat.

Number of units the discount should be applied to

Discount custom data.

Class providing calculation of custom discounts.

Calculates value of the unit discount when it is applied to the given shopping cart item.

Shopping cart item Discount data

Factory that provides SKUTreeNode for product document types

Constructor

Returns true if the factory is able to create the object of the given type

Object type

E-commerce context.

Private constructor.

Registers the properties of this object

Registers the Columns of this object

Checks the specified ecommerce permission for current user.

Permission name to be checked

Checks whether current user is authorized to access products from the specified department.

ID of the department

Indicates if user is authorized to modify specific customer. 'EcommerceModify' OR 'ModifyCustomers' permission is checked.

Indicates if user is authorized to modify specific discount coupon. For global discount coupon: 'EcommerceGlobalModify' permission is checked. For site-specific discount coupon: 'EcommerceModify' OR 'ModifyDiscounts' permission is checked.

Discount coupon to be checked

Indicates if user is authorized to modify discount coupons.

For global discount coupons (global = True): 'EcommerceGlobalModify' permission is checked. For site-specific discount coupons (global = False): 'EcommerceModify' OR 'ModifyDiscounts' permission is checked.

Indicates if user is authorized to modify specific discount level. For global discount level: 'EcommerceGlobalModify' permission is checked. For site-specific discount level: 'EcommerceModify' OR 'ModifyDiscounts' permission is checked.

Discount level to be checked

Indicates if user is authorized to modify discount level.

For global discount level (global = True): 'EcommerceGlobalModify' permission is checked. For site-specific discount level (global = False): 'EcommerceModify' OR 'ModifyDiscounts' permission is checked.

Indicates if current user is authorized to modify specific manufacturer. For global manufacturer: 'EcommerceGlobalModify' permission is checked. For site-specific manufacturer: 'EcommerceModify' OR 'ModifyManufacturers' permission is checked.

Manufacturer to be checked

Indicates if user is authorized to modify manufacturers.

For global manufacturers (global = True): 'EcommerceGlobalModify' permission is checked. For site-specific manufacturers (global = False): 'EcommerceModify' OR 'ModifyManufacturers' permission is checked.

Indicates if user is authorized to modify specific option category. For global option category: 'EcommerceGlobalModify' permission is checked. For site-specific manufacturer: 'EcommerceModify' OR 'ModifyProducts' permission is checked.

Option category to be checked

Indicates if user is authorized to modify option categories.

For global option categories (global = True): 'EcommerceGlobalModify' permission is checked. For site-specific option categories (global = False): 'EcommerceModify' OR 'ModifyProducts' permission is checked.

Indicates if user is authorized to modify specific SKU. For global SKU: 'EcommerceGlobalModify' permission is checked. For site-specific SKU: 'EcommerceModify' OR 'ModifyProducts' permission is checked.

SKU to be checked

Indicates if user is authorized to modify SKUs.

For global SKUs (global = True): 'EcommerceGlobalModify' permission is checked. For site-specific SKUs (global = False): 'EcommerceModify' OR 'ModifyProducts' permission is checked.

Indicates if user is authorized to modify specific supplier. For global supplier: 'EcommerceGlobalModify' permission is checked. For site-specific supplier: 'EcommerceModify' OR 'ModifySuppliers' permission is checked.

Supplier to be checked

Indicates if user is authorized to modify suppliers.

For global suppliers (global = True): 'EcommerceGlobalModify' permission is checked. For site-specific suppliers (global = False): 'EcommerceModify' OR 'ModifySuppliers' permission is checked.

Returns manufacturer based on the URL identifier of the current request

Sets cookie, context values according to given shopping cart and clears CurrentCurrency.

Shopping cart info object.

Context object.

Current customer.

Current customer country.

Current customer state.

Returns the current Shopping cart info.

Current currency.

Exchange Rate.

Current manufacturer object according the URL parameter of the current request. It is available when the request contains parameters "manufacturerid" or "manufacturername" with valid value of the manufacturer.

Current product.

Current product department.

Current product supplier.

Current product internal status.

Current product public status.

Module registration.

Constructor.

Module info

Initializes the module

Registers the contexts of this module

Registers the object type of this module

Gets the object created from the given DataRow.

Object DataRow Object type

Registers the object type of this module

Get invoice by OrderID

Parameters array

Get department info by department ID

Parameters array

Get e-product download URL

Parameters array

Get Url of SKU using SKUID and SKUName

Parameters array

Saves customer

Parameters array

Get customer by Customer ID

Parameters array

Get customer by User ID

Parameters array

Cleanup procedure after prices recalculation

Parameters array

Get main currency

Parameters array

Get the SKU info by guid

Parameters array

Delete the SKU info

Parameters array

Get the SKU info

Parameters array

Clears the module hashtables.

If true, web farm tasks are logged

Checks the license.

Domain name Feature Action

Class containg string contstants of all e-commerce module permissions.

Constant representing 'EcommerceRead' permission

Constant representing 'EcommerceModify' permission

Constant representing 'EcommerceGlobaModify' permission

Constant representing 'Destroy' permission

Constant representing 'ConfigurationRead' permission

Constant representing 'ConfigurationModify' permission

Constant representing 'ConfigurationGlobalModify' permission

Constant representing 'ReadOrders' permission

Constant representing 'ModifyOrders' permission

Constant representing 'ReadReports' permission

Constant representing 'ReadCustomers' permission

Constant representing 'ModifyCustomers' permission

Constant representing 'ReadProducts' permission

Constant representing 'ModifyProducts' permission

Constant representing 'AccessAllDepartments' permission

Constant representing 'ReadDiscounts' permission

Constant representing 'ModifyDiscounts' permission

Constant representing 'ReadManufacturers' permission

Constant representing 'ModifyManufacturers' permission

Constant representing 'ReadSupplliers' permission

Constant representing 'ModifySupplliers' permission

Class providing access to E-commerce related settings.

Represents CMSStoreAllowAnonymousCustomers e-commerce setting key name.

Represents CMSStoreShippingFreeLimit e-commerce setting key name.

Represents CMSShoppingCartURL e-commerce setting key name.

Represents CMSWishlistURL e-commerce setting key name.

Represents CMSDefaultProductImageURL e-commerce setting key name.

Represents CMSStoreRedirectToShoppingCart e-commerce setting key name.

Represents CMSStoreInvoiceTemplate e-commerce setting key name.

Represents CMSStoreDefaultCountryName e-commerce setting key name.

Represents CMSStoreShowTaxRegistrationID e-commerce setting key name.

Represents CMSStoreShowOrganizationID e-commerce setting key name.

Represents CMSStoreSendEmailsFrom e-commerce setting key name.

Represents CMSStoreSendEmailsTo e-commerce setting key name.

Represents CMSStoreUseExtraCompanyAddress e-commerce setting key name.

Represents CMSStoreSendOrderNotification e-commerce setting key name.

Represents CMSStoreSendPaymentNotification e-commerce setting key name.

Represents CMSStoreCheckoutProcess e-commerce setting key name.

Represents CMSStoreRequireCompanyInfo e-commerce setting key name.

Represents CMSStoreApplyTaxBasedOn e-commerce setting key name.

Represents CMSStoreWeightFormattingString e-commerce setting key name.

Represents CMSStoreUseCustomerCultureForEmails e-commerce settings key name.

Represents CMSStoreAllowGlobalProducts e-commerce setting key name.

Represents CMSStoreAllowGlobalProductOptions e-commerce setting key name.

Represents CMSStoreAllowGlobalManufacturers e-commerce setting key name.

Represents CMSStoreAllowGlobalSuppliers e-commerce setting key name.

Represents CMSStoreAllowGlobalDiscountCoupons e-commerce setting key name.

Represents CMSStoreAllowGlobalDiscountLevels e-commerce setting key name.

Represents CMSStoreAllowGlobalDepartments e-commerce setting key name.

Represents CMSStoreAllowGlobalShippingOptions e-commerce setting key name.

Represents CMSStoreAllowGlobalPaymentMethods e-commerce setting key name.

Represents CMSStoreUseGlobalTaxClasses e-commerce setting key name.

Represents CMSStoreUseGlobalCurrencies e-commerce setting key name.

Represents CMSStoreUseGlobalExchangeRates e-commerce setting key name.

Represents CMSStoreUseGlobalCredit e-commerce setting key name.

Represents CMSStoreUseGlobalOrderStatus e-commerce setting key name.

Represents CMSStoreUseGlobalPublicStatus e-commerce setting key name.

Represents CMSStoreUseGlobalInternalStatus e-commerce setting key name.

Represents CMSStoreUseGlobalInvoice e-commerce setting key name.

Pattern (macro expression) used to generate an invoice number.

Represents CMSStoreEProductsReminder e-commerce setting key name.

Represents CMSStoreRegistrationConversionName e-commerce setting key name.

Represents CMSStoreRegistrationConversionValue e-commerce setting key name.

Represents CMSStoreOrderConversionName e-commerce setting key name.

Represents CMSStoreOrderConversionValue e-commerce setting key name.

Represents CMSStoreAddToShoppingCartConversionName e-commerce setting key name.

Represents CMSStoreAddToShoppingCartConversionValue e-commerce setting key name.

Represents CMSStoreProductsStartingPath e-commerce setting key name.

Represents CMSStoreAllowProductsWithoutDocuments e-commerce setting key name.

Represents CMSStoreProductsTree e-commerce setting key name.

Represents CMSStoreProductsAreNewFor e-commerce setting key name.

Represents CMSStoreDisplayPriceIncludingDiscounts e-commerce setting key name.

Represents CMSStoreDisplayPriceIncludingTaxes e-commerce setting key name.

Represents CMSStoreRelatedProductsRelationshipName e-commerce setting key name.

Represents CMSStoreNewProductStatus e-commerce setting key name.

Represents CMSStoreDisplayProductsInSectionsTree e-commerce setting key name.

Indicates if customers need to register in your site so that they can make the purchase.

Code name of the site. Use null or empty string for global setting

Gets the minimum order value when the shipping is not charged. If not set, returns -1.

Code name of the site. Use null or empty string for global setting

Gets the URL of the shopping cart page.

Code name of the site. Use null or empty string for global setting

Gets the URL of the wish list page.

Code name of the site. Use null or empty string for global setting

Gets the URL of the default product image which is used when image of the product is not specified.

Code name of the site. Use null or empty string for global setting

Indicates if user will be redirected to shopping cart after adding product to cart.

Code name of the site. Use null or empty string for global setting

Gets HTML template used to generate an invoice (or receipt) after an order is finished and saved.

Code name of the site. Use null or empty string for global setting

Gets default country, choose your country or country where you sell the most. All taxes are applied based on their values in the default country unless the customer specifies their country or state during the checkout process.

Code name of the site. Use null or empty string for global setting

Indicates if organization ID field (e.g. VAT registration ID) should be displayed.

Code name of the site. Use null or empty string for global setting

Indicates if organization ID field should be displayed.

Code name of the site. Use null or empty string for global setting

Gets an e-mail address the e-commerce notification e-mails are sent from.

Code name of the site. Use null or empty string for global setting

Gets site-related e-mail address (e.g. merchant's e-mail address) the e-commerce notification e-mails are sent to.

Code name of the site. Use null or empty string for global setting

Indicates if the option of providing company address is available in the check out process.

Code name of the site. Use null or empty string for global setting

Indicates if e-mail notifications are sent after an order is finished and saved.

Code name of the site. Use null or empty string for global setting

Indicates if e-mail notifications are sent after an order payment is completed.

Code name of the site. Use null or empty string for global setting

Gets the checkout process used in the store shopping cart.

Code name of the site. Use null or empty string for global setting

Indicates if it is compulsory to provide company account information in the check out process.

Code name of the site. Use null or empty string for global setting

Indicates whether the tax is applied based on shipping or billing address.

Code name of the site. Use null or empty string for global setting

Gets the format used to display product weight. Use {0} expression to insert the weight into the formatting string.

Code name of the site. Use null or empty string for global setting

Indicates if emails to customer will be sent in shopping cart culture.

Code name of the site. Use null or empty string for global setting

Indicates if global products are allowed.

Code name of the site. Use null or empty string for global setting

Indicates if global product options are allowed.

Code name of the site. Use null or empty string for global setting

Indicates if global manufacturers are allowed.

Code name of the site. Use null or empty string for global setting

Indicates if global suppliers are allowed.

Code name of the site. Use null or empty string for global setting

Indicates if global discount coupons are allowed.

Code name of the site. Use null or empty string for global setting

Indicates if global discount levels are allowed.

Code name of the site. Use null or empty string for global setting

Indicates if global departments are allowed.

Code name of the site. Use null or empty string for global setting

Indicates if global shipping options are allowed.

Code name of the site. Use null or empty string for global setting

Indicates if global payment methods are allowed.

Code name of the site. Use null or empty string for global setting

Indicates if global tax classes are used.

Code name of the site. Use null or empty string for global setting

Indicates if global currencies are used.

Code name of the site. Use null or empty string for global setting

Indicates if global exchange rates are used.

Code name of the site. Use null or empty string for global setting

Indicates if global credit is used.

Code name of the site. Use null or empty string for global setting

Indicates if global order statuses are used.

Code name of the site. Use null or empty string for global setting

Indicates if global public statuses are used.

Code name of the site. Use null or empty string for global setting

Indicates if global internal statuses are used.

Code name of the site. Use null or empty string for global setting

Indicates if global invoice is used.

Code name of the site. Use null or empty string for global setting

Pattern (macro expression) for generating of invoice number.

Code name of the site. Use null or empty string for global setting

Gets number of days before e-product expiration when reminder is to be sent.

Code name of the site. Use null or empty string for global setting

Path within the content tree where sub-tree of product sections starts.

Code name of the site. Use null or empty string for global setting

Indicates whether it is possible to create products without document data.

Code name of the site. Use null or empty string for global setting

Returns the mode of displaying tree in the products administration UI.

Code name of the site. Use null or empty string for global setting

Number of days for which created products are marked as 'new products' in the store. Days are counted from the product 'In store from' property.

Code name of the site. Use null or empty string for global setting

Indicates if product prices on the live site are displayed including discounts. This takes effect only to prices which are displayed using GetSKUFormattedPrice() method.

Code name of the site. Use null or empty string for global setting

Indicates if product prices on the live site are displayed including taxes. This takes effect only to prices which are displayed using GetSKUFormattedPrice() method.

Code name of the site. Use null or empty string for global setting

Relationship name to be used for related products.

Code name of the site. Use null or empty string for global setting

Product public status which represents the status of the product which is evaluated as a new product (according to the 'Products are new for' setting and 'In store from' product property).

Code name of the site. Use null or empty string for global setting

Indicates if products will be displayed in products sections tree. This setting has no effect when not using sections tree.

Code name of the site. Use null or empty string for global setting

Name of the conversion that will be logged when a user successfully registers on the website through the checkout process.

Code name of the site. Use null or empty string for global setting

Number that will be recorded along with the Registration conversion when it is logged.

Code name of the site. Use null or empty string for global setting

Name of the conversion that will be logged when a user completes an order.

Code name of the site. Use null or empty string for global setting

Number that will be recorded along with the Order conversion when it is logged.

Code name of the site. Use null or empty string for global setting

Name of the conversion that will be logged when a user adds a product to the shopping cart.

Code name of the site. Use null or empty string for global setting

Number that will be recorded along with the specified conversion when a product is added to the shopping cart.

Code name of the site. Use null or empty string for global setting

Converts string value to ApplyTaxBasedOnEnum. Default value is ApplyTaxBasedOnEnum.BillingAddress.

'ShippingAddress' or 'BillinAddress'.

Converts ApplyTaxBasedOnEnum to string value. Default value is BILLINGADDRESS.

TaxBased on option.

Converts string value to ProductsTreeModeEnum. Default value is ProductsTreeModeEnum.None.

'Sections' or 'None'.

Converts ProductsTreeModeEnum to string value. Default value is None.

Product tree mode option.

Ensures fully qualified settings key name when site name is null or empty.

Name of the site Name of the settings key

If true, order item parameters, such as order item name and order item unit price, can be modified when editing an existing order. Value is taken from webconfig key CMSEnableOrderItemEditing. Default value is false.

Indicates if current SKU data are used instead of order item data when editing existing order. Value is taken from webconfig key CMSUseCurrentSKUData. Default value is false.

Indicates if meta file should be used for product image. Value is taken from webconfig key CMSUseMetaFileForProductImage. Default value is true.

Number of days before the shopping cart is expired. Value is taken from webconfig key CMSShoppingCartExpirationPeriod. Default value is 30 days.

AddressInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Returns value of property (additional support for Country and State properties).

Column name Returns the value Returns true if the operation was successful (the value was present)

Inserts cloned object to DB.

Cloning settings Cloning result Original source BaseInfo (object being cloned)

Returns formatted address text.

Constructor - Creates an empty AddressInfo object.

Constructor - Creates a new AddressInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Address customer ID.

Address ZIP code.

Address state ID.

Address phone.

Address country ID.

Address ID.

Address name.

Address personal name.

Address line 1.

Indicates if the address is enabled.

Address line 2.

Address city.

Indicates if the address is supposed to be used as shipping address.

Indicates if the address is supposed to be used as billing address.

Indicates if the address is supposed to be used as company address.

Address GUID.

Date and time when the address was last modified.

Class providing AddressInfo management.

Constructor.

Returns dataset of all addresses matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all addresses matching the specified parameters.

Where condition Order by expression

Returns address with specified ID.

Address ID

Sets (updates or inserts) specified address.

Address to be set

Deletes specified address.

Address to be deleted

Deletes address with specified ID.

Address ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all addresses matching the specified parameters.

ID of the customer the address belongs to Indicates if customer's billing addresses should be included into to result Indicates if customer's shipping addresses should be included into to result Indicates if customer's company addresses should be included into to result Indicates if only customer's enabled addresses should be returned

Returns address name created from the address parameters. The format of the address name is [personal or company name], [address line 1], [address line 2], [city].

Address data

Checks the address dependencies. Returns true if there are depending objects.

Address ID

Returns dataset of all addresses matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns address with specified ID.

Address ID

Sets (updates or inserts) specified address.

Address to be set

Deletes specified address.

Address to be deleted

Returns dataset of all addresses matching the specified parameters.

ID of the customer the address belongs to Indicates if customer's billing addresses should be included into the result Indicates if customer's shipping addresses should be included into the result Indicates if customer's company addresses should be included into the result Indicates if only customer's enabled addresses should be returned

Returns address name created from the address parameters. The format of the address name is [personal or company name], [address line 1], [address line 2], [city].

Address data

CustomerListInfo virtual object.

Type information.

Constructor - Creates an empty CustomerListInfo object.

Returns the data according to the set of input parameters.

Query parameters Where condition to filter data Order by statement Specifies number of returned records Data columns to return If true, binary data are returned in the result Index of first record to get Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used) Returns total number of available records

Options saying what the taxes are to be based on.

Taxes are based on billing address.

Taxes are based on shipping address.

Inventory removal options for bundle products.

Remove only bundle itself from inventory.

Remove only bundle items from inventory.

Remove both bundle and bundle items from inventory.

Type of the product option category.

Category of this type represents specific optional accessories of the product which is selected by the customer from the predefined list of products.

Category of this type represents specific attribute of the product which is configured by the customer from the predefined list of values, e.g. color.

Category of this type represents text attribute of the product which is entered by the customer, e.g.: label for the T-shirt

Options specifying how will the products be organized in product management UI.

No products tree.

Products tree based on documents.

SKU product type options.

Standard product type.

Membership product type.

E-product product type.

Donation product type.

Bundle product type.

Text product type. Used for product options to which customer is able to define his custom text, e.g. custom label for a T-shirt.

Class representing tax which should be applied to the specified shopping cart item. It implements IItemTaxinterface.

Constructor - Creates an empty ItemTax object.

Constructor - Creates a new ItemTax object from serialized data.

Stores all the data needed to serialize or deserialize the object Describes the source and destination of a given serialized stream

Gets object data.

Tax class unique identifier.

Tax class display name.

Tax class value. It can be either relative or flat according to the ItemTaxClassIsFlat property.

True - tax class value is flat, False (default) - tax class is relative.

True - tax class value is set in global main currency, False (default) - tax class value is set in site main currency. Takes effect only if tax class is flat.

True - if customer's tax ID is supplied, the tax value for the customer is zero. False (default) - value of the tax is calculated

Tax class custom data.

Collection of customer orders represented by OrderInfo objects

Registers supported properties

List with supported properties

Returns true if given column name exists and the value can be returned.

Name of the column Here the result of GetValue is returned

Constructor - creates collection of orders for the given customer

Customer ID ID of the site from which the customer orders should be loaded. Use 0 to fill collection with customer orders from all sites.

Total volume of all customer orders. Value is expressed in site main currency for site orders. Result is in global main currency when collection contains orders from all sites.

OrderItemSKUFileInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty OrderItemSKUFileInfo object.

Constructor - Creates a new OrderItemSKUFileInfo object from the given DataRow.

DataRow with the object data.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Unique download identifier.

Parent order item ID.

Number of times the file was downloaded.

Order item SKU file ID.

Associated SKU file ID.

Class providing OrderItemSKUFileInfo management.

Returns dataset of all order item SKU files matching the specified parameters.

Where condition. Order by expression. Number of records to be selected. Columns to be selected.

Returns dataset of all order item SKU files matching the specified parameters.

Where condition. Order by expression.

Returns order item SKU file with specified ID.

Order item SKU file ID.

Returns order item SKU file with specified unique token.

Order item SKU file unique token.

Sets (updates or inserts) specified order item SKU file.

Order item SKU file to be set.

Deletes specified order item SKU file.

Order item SKU file to be deleted.

Deletes order item SKU file with specified ID.

Order item SKU file ID.

Returns dataset of all order item SKU files matching the specified parameters with additional details.

Order ID

Returns e-product download URL.

File unique download token File name Site ID of the order in which the e-product is included

Returns dataset of all order item SKU files matching the specified parameters.

Where condition. Order by expression. Number of records to be selected. Columns to be selected.

Returns order item SKU file with specified ID.

Order item SKU file ID.

Returns order item SKU file with specified unique token.

Order item SKU file unique token.

Sets (updates or inserts) specified order item SKU file.

Order item SKU file to be set.

Deletes specified order item SKU file.

Order item SKU file to be deleted.

Returns dataset of all order item SKU files matching the specified parameters with additional details.

Order ID

OrderListInfo virtual object.

Type information.

Constructor - Creates an empty OrderListInfo object.

Returns the data according to the set of input parameters.

Query parameters Where condition to filter data Order by statement Specifies number of returned records Data columns to return If true, binary data are returned in the result Index of first record to get Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used) Returns total number of available records

ShippingCostInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty ShippingCostInfo object.

Constructor - Creates a new ShippingCostInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Shipping cost unique identifier.

Date and time when the shipping cost was last modified.

Order minimal weight the shipping cost is applied for.

ID of the shipping option the shipping cost belongs to.

Shipping cost value.

Shipping cost ID.

Class providing ShippingCostInfo management.

Returns dataset of all shipping costs matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of shipping costs for all weight categories in given shipping option. Result is ordered by min weight.

Id of the shipping option

Returns shipping cost with specified ID.

Shipping cost ID

Returns appropriate shipping cost for given shipping option and weight.

Id of the shipping option Weight of delivery

Sets (updates or inserts) specified shipping cost.

Shipping cost to be set

Deletes specified shipping cost.

Shipping cost to be deleted

Deletes shipping cost with specified ID.

Shipping cost ID

Recalculates costs values using the given coefficient. Shipping option charge of parent shipping option record will NOT be changed.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional where condition

Returns dataset of all shipping costs matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of shipping costs for all weight categories in given shipping option. Result is ordered by min weight.

Id of the shipping option

Returns shipping cost with specified ID.

Shipping cost ID

Returns appropriate shipping cost for given shipping option and weight of delivery.

Id of the shipping option Weight of delivery

Sets (updates or inserts) specified shipping cost.

Shipping cost to be set

Deletes specified shipping cost.

Shipping cost to be deleted

Recalculates costs values using the given coefficient. Shipping option charge of parent shipping option record will NOT be changed.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional where condition

ShippingOptionTaxClassInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty ShippingOptionTaxClassInfo object.

Constructor - Creates a new ShippingOptionTaxClassInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Tax class ID.

Shipping option ID.

Class providing ShippingOptionTaxClassInfo management.

Returns dataset of all relationships between shipping options and tax classes matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all relationships between shipping options and tax classes matching the specified criteria.

Where condition Order by expression

Returns relationship between specified shipping option and tax class.

Shipping option ID Tax class ID

Sets relationship between specified shipping option and tax class.

Shipping option-tax class relationship to be set

Deletes relationship between specified shipping option and tax class.

Shipping option-tax class relationship to be deleted

Sets relationship between specified shipping option and tax class.

Shipping option ID Tax class ID

Deletes relationship between specified shipping option and tax class.

Shipping option ID Tax class ID

Returns dataset of all relationships between specified shipping option and tax classes.

Shipping option ID

Returns dataset of all relationships between shipping options and tax classes matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns relationship between specified shipping option and tax class.

Shipping option ID Tax class ID

Sets relationship between specified shipping option and tax class.

Shipping option-tax class relationship to be set

Deletes relationship between specified shipping option and tax class.

Shipping option-tax class relationship to be deleted

Returns dataset of all relationships between specified shipping option and tax classes.

Shipping option ID

Type information.

Constructor - Creates an empty OrderStatusUserListInfo object.

Constructor - Creates a new OrderStatusUserListInfo object from the given DataRow.

DataRow with the object data

Returns the data according to the set of input parameters.

Query parameters Where condition to filter data Order by statement Specifies number of returned records Data columns to return If true, binary data are returned in the result (not applied) Index of first record to get Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used) Returns total number of available records

Container for results of cart item checks.

Dictionary of ShoppingCartItem check results indexed by the ID of SKU.

List of ShoppingCartItem check results.

Adds specified item check result to this cart check result object.

Item check result to be added.

Returns check result formatted as string. Message consists of common error message followed by individual item error messages separated using specified separators. Empty string is returned when no errors found.

String to be used as a separator between messages from individual items. String to be used as a separator between messages from one item.

Returns HTML formatted error message when check has failed, meaning that errors from each item are on its own line using [br /] HTML tag. Returns empty string if check passed.

Returns formatted error message when check has failed, meaning that errors from each item are on its own line using end-of-line char. Returns empty string if check passed.

Results for all products which have failed during check.

Dictionary of ShoppingCartItem check results indexed by the ID of SKU.

Indicates whether check has failed (at least one cart item check has failed).

Class encapsulating the results of cart item check.

Includes specified check result into this object in order to find the most restrictive values. No action is taken when results belong to different SKUs.

Result to be included.

Returns check result formatted as string. Message contains individual error messages separated with specified separator. Empty string is returned when no errors found.

String to be used as a separator between messages.

Returns formatted result message when check has failed. Message is HTML-formatted: each error on its own line. Returns empty string if check passed.

Marks this result as "Minimum unit count not reached".

Minimum unit count in one order which was not satisfied.

Marks this result as "Maximum unit count not reached".

Maximum unit count in one order which was not satisfied.

Marks this result as "Not enought units available".

Maximum available unit count.

Marks this result with error message. Use this method to report custom errors. Duplicit entries are removed.

Error message to add.

Returns smaller value from params. Values below 0 are considered to be "not specified".

First value Second value

Returns larger value from params. Values below 0 are considered to be "not specified".

First value Second value

Affected shopping cart item object.

List of other (custom) error messages.

Indicates whether result has any other (custom) errors.

Number of available units when not enough. Value is set to -1 when all requested units are available.

Minimum unit count in one order. Value is set to -1 when minimum units in order condition is met.

Maximum unit count in one order. Value is set to -1 when maximum units in order condition is met.

Indicates that minimum unit count in one order condition is not met.

Indicates that maximum unit count in one order condition is not met.

Indicates that requested unit count is not available.

Indicates that product is disabled.

Indicates that product has expired.

Indicates that product can not be purchased, because it requires registered customer.

Indicates whether the check has failed.

Data container of the parameters which represent configuration of the shopping cart item to be added/updated in the shoppping cart object.

Returns initialized shopping cart item parameters container from the current URL parameters.

Constructor - creates empty shopping cart item parameteres container.

Constructor - creates initialized shopping cart item parameteres container.

Product SKU ID. Number of product units.

Constructor - creates initialized shopping cart item parameteres container.

Product SKU ID. Number of product units. SKU IDs of product options.

Constructor - creates initialized shopping cart item parameteres container.

Product SKU ID. Number of product units. List of product options parameters.

Product SKU ID.

Number of product units.

Product custom price, e.g. amount of donation. It is in site main currency.

Product custom text defined by the customer, e.g. custom label for a T-shirt. Makes sense only for the text product option.

Indicates if product is added to the shopping cart as private. Makes sense only for the private Donation. It is false by default.

Collection of the product options.

Collection (name - value pairs) of the shopping cart item custom parameters.

Base page for the E-commerce products advanced properties pages to apply global settings to the pages.

Base page for the E-commerce products properties pages to apply global settings to the pages.

Base page for the E-commerce products pages to apply global settings to the pages.

Base page for E-commerce pages working with site specific records with option to include global records.

Base page for the E-commerce pages to apply global settings to the pages.

Page OnPreInit event.

Page OnInit event.

Event args

Checks if the site specified by the site ID has a main currency defined. Returns null if the main currency is defined, otherwise returns a warning message.

ID of site to check

Checks the security.

Adds script for selecting of ecommerce menu button.

UI Element code name (button) URL to redirect to

Id of the site. Value taken from query string parameter "siteId", or from CMSContext.CurrentSiteID when no SiteId supplied or not a global admin. Special values (non-positive) are passed without change.

Stores given value into cookie named 'SiteFilter'.

New value

Returns value from dictionary stored in CMSSiteFilter cookie.

Name of the key.

Sets value to dictionary stored in CMSSiteFilter cookie.

Name of the key. Value to be set.

Checks if site id of edited object corresponds to configured site ID and site settings. If it does not, user is redirected to 'Object doesn't exist' page.

ID of the site which edited object belongs to

Appends site mark to given object name according to current ui culture.

Name of the object. Site id of named object.

Settings key name allowing usage of global objects.

Indicates global objects are allowed on current site besides site-specific ones. Type of the objects depends on settings key name set in GlobalObjectsKeyName property.

Returns id of the configured site. For global admin allows to configure global objects on demand (siteId in querystring == 0). In other cases returns 0 (when global objects allowed and asked for global objects) or current site ID (when using site specific configuration only).

Gets startup value for site selector. Value is taken from query parameter siteId or from cookie when parameter is missing.

Key for site filter preference dictionary stored in cookie.

Page OnPreInit event.

Event args

Page OnInit event.

Event args

Checks users permissions to modify product. Modify permissions and permissions to departments are checked. Returns true when OK.

SKU to be checked.

Appends nodeId parameters to given URL.

URL to append parameters to

Appends nodeId and siteId parameters to given URL.

URL to append parameters to

Checks if site id of edited object corresponds to current site ID and site settings. If it does not, user is redirected to 'Object doesn't exist' page.

ID of the site which edited product belongs to

Called when requested language version of product section does not exist in split mode.

Called when requested language version of document does not exist in split mode.

Parameter to be supplied in query under 'mode' key.

Redirects to new culture page

Generates breadcrumbs for node specified in the Node property. Reflects Products starting path setting.

Generates breadcrumbs for node specified in the Node property. Reflects Products starting path setting.

TreeNode to create breadcrumbs for. Current document is used when null. When specified, this string is used as last breadcrumb item (no link, just info text).

Returns script executed after the breadcrumb is clicked.

Datarow containing document data.

Gets UI page URL for document action.

URL configuration object

Gets UI page URL for URL configuration object.

URL configuration object

Creates DialogConfiguration object for specified product document action.

Action to create configuration for. Culture code

Indicates whether the page is for normal product or for product option.

Indicates if content tree is displayed in product management UI. Value is based on setting for current site.

Starting path indicating where the product sub tree starts. Reflects also UserStartingAliasPath property of current user.

ID of the product taken from query parameter 'productId' or from node specified by query parameter 'nodeId'.

Page OnInit event.

Event args

Returns true if the title of product advanced properties page is to be displayed

BundleInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty BundleInfo object.

Constructor - Creates a new BundleInfo object from the given DataRow.

DataRow with the object data.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Bundle ID.

SKU ID.

Class providing BundleInfo management.

Returns dataset of all relationships between bundles and SKUs matching the specified criteria.

Where condition. Order by expression. Number of records to be selected. Columns to be selected.

Returns dataset of all relationships between bundles and SKUs matching the specified criteria.

Where condition. Order by expression.

Returns relationship between specified bundle and SKU.

Bundle ID. SKU ID.

Sets relationship between specified bundle and SKU.

Bundle-SKU relationship to be set.

Deletes relationship between specified bundle and SKU.

Bundle-SKU relationship to be deleted.

Sets relationship between specified bundle and SKU.

Bundle ID. SKU ID.

Deletes relationship between specified bundle and SKU.

Bundle ID. SKU ID.

Returns dataset of all relationships between bundles and SKUs matching the specified criteria.

Where condition. Order by expression. Number of records to be selected. Columns to be selected.

Returns relationship between specified bundle and SKU.

Bundle ID. SKU ID.

Sets relationship between specified bundle and SKU.

Bundle-SKU relationship to be set.

Deletes relationship between specified bundle and SKU.

Bundle-SKU relationship to be deleted.

SKUFileInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty SKUFileInfo object.

Constructor - Creates a new SKUFileInfo object from the given DataRow.

DataRow with the object data.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

File type.

File name.

Application root relative path to the file.

Date and time when the file object was last modified.

File GUID.

File ID.

Parent SKU ID.

Associated meta file GUID.

Class providing SKUFileInfo management.

Returns dataset of all SKU files matching the specified parameters.

Where condition. Order by expression. Number of records to be selected. Columns to be selected.

Returns dataset of all SKU files matching the specified parameters.

Where condition. Order by expression.

Returns SKU file with specified ID.

Sku file ID.

Sets (updates or inserts) specified SKU file.

Sku file to be set.

Deletes specified SKU file.

Sku file to be deleted.

Deletes SKU file with specified ID.

Sku file ID.

Checks dependencies, returns true if dependent.

SKU file identifier

Checks dependencies, returns true if dependent.

SKU file info object

Returns dataset of all SKU files matching the specified parameters.

Where condition. Order by expression. Number of records to be selected. Columns to be selected.

Returns SKU file with specified ID.

Sku file ID.

Sets (updates or inserts) specified SKU file.

Sku file to be set.

Deletes specified SKU file.

Sku file to be deleted.

SKUListInfo virtual object.

Type information SKU.

Constructor - Creates an empty SKUListInfo object.

Returns the data according to the set of input parameters.

Query parameters Where condition to filter data Order by statement Specifies number of returned records Data columns to return If true, binary data are returned in the result Index of first record to get Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used) Returns total number of available records

WishlistItemInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty WishlistItemInfo object.

Constructor - Creates a new WishlistItemInfo object from the given DataRow.

DataRow with the object data

Site ID.

User ID.

SKU ID.

Class providing WishlistItemInfo management.

Returns dataset of all wishlist items matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all wishlist items matching the specified criteria.

Where condition Order by expression

Returns specified wishlist item.

User ID Product ID Site ID

Sets specified wishlist item.

Wishlist item to be set

Deletes specified wishlist item.

Wishlist item to be deleted

Adds product to specified wishlist.

User ID Product ID Site ID

Removes specified wishlist item.

User ID Product ID Site ID

Returns dataset of all wishlist items matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns specified wishlist item.

User ID Product ID Site ID

Sets specified wishlist item.

Wishlist item to be set

Deletes specified wishlist item.

Wishlist item to be deleted

Base page for the E-commerce product pages in content to apply global settings to the pages.

Page OnPreInit event.

Event args

Page OnInit event.

Event args

Checks if current user is authorized to edit department of specified product. Returns empty string when user IS authorized, returns error message when user IS NOT authorized.

Product to check

Checks if site id of edited product corresponds to configured site ID and site settings. If it does not, user is redirected to 'Object doesn't exist' page.

ID of the site which edited object belongs to

Checks users permissions to modify product. Modify permissions, permissions to departments and document permissions are checked. Returns true when OK.

SKU info object.

Base page for the CMS Ecommerce modal pages to apply global settings to the pages.

Page OnInit event.

Event args

Base page for the E-commerce currencies to apply global settings to the pages.

Base page for the E-commerce configuration pages, which can be opened under CMSDesk as well as under SiteManager. These pages are aimed for handling "global only" or "site-specific only" records.

Base page for the E-commerce configuration pages to apply global settings to the pages.

Page OnInit event.

Event args

Checks authorization to UI elements under E-commerce / Configuration.

Page OnInit event.

Event args

Checks ecommerce ConfigurationModify and ConfigurationGlobalModify permissions. Redirects to access denied page if check fails.

Checks if site id of edited object corresponds to configured site. If it does not, user is redirected to 'Object doesn't exist' page.

ID of the site which edited object belongs to

Settings key name configuring usage of global/site objects.

Indicates if current site uses global objects. Type of objects depends on settings key name set in GlobalObjectsKeyName property.

Returns id of the configured site. For global admin with site manager enabled allows to configure global objects on demand (siteId in querystring == 0). In other cases returns 0 (when using global objects) or current site ID (when using site specific configuration).

Page OnInit event.

Event args

Base page for the E-commerce departments to apply global settings to the pages.

Base page for E-commerce pages working with site specific records with option to include global records. This page extends CMSEcommerceObjectsPage with check of UI elements. It is aimed as base for configuration pages accesible from CMSDesk / Ecommerce / Configuration.

Page OnInit event.

Event args

Checks ecommerce ConfigurationModify and ConfigurationGlobalModify permissions. Redirects to access denied page if check fails.

Site id of the configured object

Page OnInit event.

Event args

Base page for the E-commerce exchange rates to apply global settings to the pages.

Page OnInit event.

Event args

Base page for the E-commerce internal statuses to apply global settings to the pages.

Page OnInit event.

Event args

Base page for the E-commerce manufacturers pages to apply global settings to the pages.

Page OnInit event.

Event args

Base page for the E-commerce order statuses to apply global settings to the pages.

Page OnInit event.

Event args

Base page for the E-commerce payment methods to apply global settings to the pages.

Page OnInit event.

Event args

Base page for the E-commerce pubic statuses to apply global settings to the pages.

Page OnInit event.

Event args

Base page for the E-commerce shipping options to apply global settings to the pages.

Page OnInit event.

Event args

Base page for the E-commerce store settings pages to apply global settings to the pages.

Gets string array representing default header actions for store settings.

Check whether the user is authorized to modify configuration and returns true if so. This method needs to be overridden to save store settings.

Override this method to handle saving of store settings.

Handles default actions performed on the master header (Save changes action).

Handles postback event with argument "save". Permissions are checked and method SaveChanges() is called as reaction.

Postback argument

Base page for the E-commerce suppliers pages to apply global settings to the pages.

Page OnInit event.

Event args

Base page for the E-commerce tax classes to apply global settings to the pages.

Page OnInit event.

Event args

Base page for the E-commerce customers pages to apply global settings to the pages.

Page OnInit event.

Event args

Returns true if customer is anonymous on current site or has login on current site.

Customer object

Base page for the E-commerce discount coupons pages to apply global settings to the pages.

Page OnInit event.

Event args

Base page for the E-commerce discount levels pages to apply global settings to the pages.

Page OnInit event.

Event args

Base page for the E-commerce orders modal pages to apply global settings to the pages.

Page OnInit event.

Event args

Gets or sets the customer ID. According to this ID the permissions are checked.

Base page for the E-commerce orders pages to apply global settings to the pages.

Page OnInit event.

Event args

Checks the security.

ID of the customer

Checks whether supplied siteId corresponds to current site ID and sets EditedObject to null if not. Check applies to non-globaladmin users only.

Gets or sets the customer ID. According to this ID the permissions are checked.

Base page for the E-commerce product options pages to apply global settings to the pages.

Page OnInit event.

Event args

Base page for the E-commerce product options pages to apply global settings to the pages.

Authorize.NET payment result.

Class representing payment result.

Returns payment result item object.

Item name

Updates/Inserts payment result item data in/into payment result.

Payment result item data object

Returns payment result XML string.

Returns formatted payment result string which is visible to the user.

Loads payment result xml.

Payment result XML to load

Tries to find specified payment result item (if it is not found it is created and initialized with item name and item header) and returns it.

Payment result item name to get Payment result item header text which is set to the new item when requested item is not found

Constructor - Creates a new PaymentResultInfo object from serialized data.

Serialization data Context

Gets object data.

Creates PaymentResultInfo object.

Payment result in XML format

Creates base PaymentResultInfo object - following fields are created in payment result XML definition, they are not initialized: date, payment method, payment is completed, payment status, transaction id, description.

Root node of the payment result xml definition.

Payment date.

TRUE - payment was completed successfully, FALSE - payment wasn't already completed.

Payment result description.

Payment result transaction ID.

Payment method name.

Payment method ID.

Payment status value.

Payment status display name.

Creates base payment result info object + add Authorize.NET payment result properties.

Authorization code.

CreditEventInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty CreditEventInfo object.

Constructor - Creates a new CreditEventInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Event name.

ID of the customer the event belongs to.

Event ID.

Event description.

Event date.

Event credit change.

Event credit GUID.

Date and time when the credit event was last modified.

Credit event site ID. Set to 0 for global credit event.

Class providing CreditEventInfo management.

Returns dataset of all credit events matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all credit events matching the specified parameters.

Where condition Order by expression

Returns credit event with specified ID.

Credit event ID

Sets (updates or inserts) specified credit event.

Credit event to be set

Deletes specified credit event.

Credit event to be deleted

Deletes credit event with specified ID.

Credit event ID

Returns dataset of all customers' credit events.

Customer ID Site ID

Deletes all customers' credit events.

Customer ID Site ID

Returns customer's total credit.

Customer ID Site ID

Returns dataset of all credit events for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns credit event name built from order data.

Order data

Returns credit event description built from order data.

Order data

Recalculates credit event values using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional WHERE condition ID of the site which records are to be recalculated

Returns dataset of all credit events matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns credit event with specified ID.

Credit event ID

Sets (updates or inserts) specified credit event.

Credit event to be set

Deletes specified credit event.

Credit event to be deleted

Returns dataset of all credit events matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all customers' credit events for specified site.

Customer ID Site ID

Deletes all customer's credit events.

Customer ID Site ID

Returns customer's total credit.

Customer ID Site ID

Returns credit event name built from order data.

Order data

Returns credit event description built from order data.

Order data

Recalculates credit event values using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Where condition ID of the site which records are to be recalculated

CurrencyInfo data container class.

Type information

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Fills data properties with values from given template.

Template to copy data from

Inserts cloned object to DB.

Cloning settings Cloning result Original source BaseInfo (object being cloned)

Constructor for deserialization.

Serialization inf Streaming context

Constructor - Creates an empty CurrencyInfo object.

Constructor - Creates a new CurrencyInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Currency display name.

Currency code name.

Currency code.

Currency ID.

Indicates if currency is enabled.

Indicates if currency is main currency.

Currency formatting string.

Number of digits the price in this currency is rounded to.

Currency GUID.

Date and time when the currency was last modified.

Currency site ID. Set to 0 for global currency.

Class providing CurrencyInfo management.

Constructor.

Main currencies indexed by the site ID

Table lock for loading.

Returns dataset of all currencies matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all currencies matching the specified parameters.

Where condition Order by expression

Returns currency with specified ID.

Currency ID

Returns currency with specified name.

Currency name Site name

Sets (updates or inserts) specified currency.

Currency to be set

Deletes specified currency.

Currency to be deleted

Deletes currency with specified ID.

Currency ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all currencies matching the specified parameters.

ID of the site the currencies should be retrieved from. If set to 0, global currencies are retrieved If true, only enabled currencies are returned

Returns dataset of all currencies matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns DataSet with the enabled currencies which have the exchange rate set.

Site ID

Returns true if site specified by its ID has defined exchange rate to given currency. Only enabled currencies are searched.

ID of currency to be looked for ID of the site to get exchange table for

Checks the currency dependencies. Returns true if there are depending objects.

Currency ID

Returns main currency of the specified site.

Site ID for site main currency or 0 for global main currency

Returns code of main currency for given site. Returns empty string when not found.

Site ID for site main currency or 0 for global main currency

Returns rounded price according to the specified currency.

Price to be rounded Currency which supplies 'round to' parameter - number of digits the price is rounded to

Returns rounded price according to the specified currency.

Price to be rounded ID of the currency which supplies 'round to' parameter - number of digits the price is rounded to

Returns formatted price according to formatting string of the specified currency.

Price to be formatted Currency which supplies formatting string

Returns formatted price according to formatting string of the current site main currency.

Price to be formatted

Returns formatted price according to formatting string of the specified site main currency.

Price to be formatted ID of the site which main currency has to be used for formatting

Returns formatted price, by default formatting string "{0:0.00}" is used.

Price to be formatted Currency which can supply formatting string or 'round to' parameter - number of digits the price should be rounded to. Be default currency has no effect to the result and formatting string "{0:0.00}" is used.

Copies global currencies to the specified site.

ID of the target site

Changes main currency and recalculates speciffied "money" values.

ID of the site, which main currency is to be changed ID of the new main currency Exchange rate which will be used wen recalculating Number of decimal digits to which the result will be rounded Determines which objects are to be recalculated

Clears specified hashtables for the values to be actual. This method is called after changing main currency.

Setting for value recalculation process

Returns dataset of all currencies matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns currency with specified ID.

Currency ID

Returns currency with specified name from specified site.

Currency name Site name. Use null for global currency

Sets (updates or inserts) specified currency.

Currency to be set

Deletes specified currency.

Currency to be deleted

Returns dataset of all currencies matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all currencies matching the specified parameters.

ID of the site the currencies should be retrieved from. If set to 0, global currencies are retrieved True - only enabled currencies from the specified site are returned. False - all site currencies are returned

Returns dataSet with the enabled currencies which have the exchange rate set.

Site ID

Returns true if site specified by its ID has defined exchange rate to given currency. Only enabled currencies are searched.

ID of currency to be looked for ID of the site to get exchange table for

Returns main currency of specified site.

Site ID for site main currency or 0 for global main currency

Returns main currency code for given site or empty string when not found.

Site ID for site main currency or 0 for global main currency code

Returns rounded price.

Price to be rounded Currency which supplies 'round to' parameter - number of digits the price is rounded to

Returns formatted price according to formatting string of the specified site main currency.

Price to be formatted Id of the site which main currency has to be used for formatting

Returns formatted price according to formatting string of the specified currency.

Price to be formatted Currency which supplies formatting string

Returns formatted price, by default formatting string "{0:0.00}" is used.

Price to be formatted Currency which can supply formatting string or 'round to' parameter - number of digits the price should be rounded to. Be default currency has no effect to the result and formatting string "{0:0.00}" is used.

Copies global currencies to the specified site.

ID of the target site

Changes main currency and recalculates speciffied "money" values.

ID of the site, which main currency is to be changed ID of the new main currency Exchange rate which will be used wen recalculating Number of decimal digits to which the result will be rounded Determines which objects are to be recalculated

Recalculates specified values with given exchange rate.

ID of the old main currency ID of the new main currency ID of the site to be recalculated Exchange rate which will be used when recalculating Number of decimal digits to which the result will be rounded Determines which objects are to be recalculated

Clears specified hashtables for the values to be actual. This method is called after changing main currency.

Setting for value recalculation process

Loads all main currencies to hashtable.

Attempts to delete currency info. Disables record if something depends on this currency.

Currency to delete or disable

Builds parameter string for webfarm task.

Main currencies indexed by the site ID

CustomerInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Inserts cloned object to DB.

Cloning settings Cloning result Original source BaseInfo (object being cloned)

Constructor for deserialization.

Serialization inf Streaming context

Constructor - Creates an empty CustomerInfo object.

Constructor - Creates a new CustomerInfo object from the given DataRow.

Registers properties of the object

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Customer e-mail.

Customer fax.

Indicates whether the customer is enabled.

ID of the customer's country.

ID of the customer's state.

ID of the customer's user account. If set, it says that the customer is registered.

Registered user information. It is null for anonymous customer.

Customer ID.

Customer last name.

Customer phone.

Customer first name.

Customer company name.

Customer GUID.

Customer tax registration ID.

Customer organization ID.

ID of the discount level which is assigned to the customer.

Date and time when the customer was created.

Date and time when the customer was last modified.

Customer site ID.

ID of the customer's preferred currency.

ID of the customer's preferred payment option.

ID of the customer's preferred shipping option.

Indicates if customer has login (meaning CustomerUserID is set).

Collection of customer orders made on current site.

Collection of all customer orders.

Collection of all customer purchased products from all sites.

Collection of all customer wishlist items from all sites. It is empty, if customer is not registered.

Class providing CustomerInfo management.

Constructor.

Returns dataset of all customers matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all customers matching the specified parameters.

Where condition Order by expression

Returns customer with specified ID.

Customer ID

Sets (updates or inserts) specified customer.

Customer to be set

Deletes specified customer.

Customer to be deleted

Deletes customer with specified ID.

Customer ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all customers for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all customers for specified site.

Site ID

Returns dataset of all customers joined with the country and state data.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all customers joined with the country and state data.

Query parameters Where condition to filter data Order by statement Specifies number of returned records Data columns to return If true, binary data are returned in the result Index of first record to get Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used) Returns total number of available records

Returns customer with specified user ID.

User ID of the required customer

Returns UserSiteInfo object for specified customer on given site.

ID of the customer to get UserSite info for ID of the site

Checks customer dependencies, return true if dependent.

Customer ID

Indicates if user is authorized to modify customers. 'EcommerceModify' OR 'ModifyCustomers' permission is checked.

Site name User to be checked

Updates shopping carts customers preference by those selected in shopping cart. Updated fields are preferred currency, shipping and payment option. Registered customers preferences will be updated in UserSite binding table for shopping carts site. Anonymous customer's preferences are updated directly in customer record.

Shopping cart info object

Invalidates customer (and user when registered) who made given order.

ID of the customer to be invalidated.

Returns dataset of all customers matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns customer with specified ID.

Customer ID

Sets (updates or inserts) specified customer.

Customer to be set

Deletes specified customer.

Customer to be deleted

Returns dataset of all customers for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all customers for specified site.

Site ID

Returns dataset of all customers joined with the country and state data.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all customers joined with the country and state data.

Query parameters Where condition to filter data Order by statement Specifies number of returned records Data columns to return If true, binary data are returned in the result Index of first record to get Maximum number of records to get. If maxRecords is zero or less, all records are returned (no paging is used) Returns total number of available records

Returns customer with specified user ID.

User ID of the required customer

Returns UserSiteInfo object for specified customer on given site.

ID of the customer to get UserSite info for ID of the site

Checks customer dependencies, return true if dependent.

Customer ID

Updates preferences of the registered customer by those selected in the shopping cart. Updated fields are preferred currency, shipping and payment option. It has no effect if customer is anonymous.

Shopping cart data

Invalidates customer (and user when registered) who made given order.

ID of the customer to be invalidated.

Removes object dependencies.

Object being deleted.

DepartmentInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty DepartmentInfo object.

Constructor - Creates a new DepartmentInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Code name of the department.

ID of the departmnet.

Display name of the department.

Department default tax class ID.

Department GUID.

Object last modified.

Department site ID. Set to 0 for global department.

Class providing DepartmentInfo management.

Constructor.

Returns dataset of all departments matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all departments matching the specified parameters.

Where condition Order by expression

Returns department with specified ID.

Department ID

Returns department with specified name.

Department name Site name

Sets (updates or inserts) specified department.

Department to be set

Deletes specified department.

Department to be deleted

Deletes department with specified ID.

Department ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all departments for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all departments for specified site.

Site ID

Returns dataset of all departments for specified user.

User ID

Returns dataset of all departments which are assigned to the specified discount level.

User ID

Checks dependencies, returns true if dependent.

Department ID

Returns dataset of all departments matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns department with specified ID.

Department ID

Returns department with specified name.

Department name Site name

Sets (updates or inserts) specified department.

Department to be set

Deletes specified department.

Department to be deleted

Returns dataset of all departments for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all departments for specified site.

Site ID

Returns dataset of all departments for specified user.

User ID

Returns dataset of all departments which are assigned to the specified discount level.

Discount level ID

DepartmentTaxClassInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty DepartmentTaxClassInfo object.

Constructor - Creates a new DepartmentTaxClassInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Department ID.

TaxClass ID.

Class providing DepartmentTaxClassInfo management.

Returns dataset of all relationships between departments and tax classes matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all relationships between departments and tax classes matching the specified criteria.

Where condition Order by expression

Returns relationship between specified department and tax class.

Department ID Tax class ID

Sets relationship between specified department and tax class.

Department-tax class relationship to be set

Deletes relationship between specified department and tax class.

Department-tax class relationship to be deleted

Sets relationship between specified department and tax class.

Tax class ID Department ID

Deletes relationship between specified department and tax class.

Tax class ID Department ID

Returns dataset of all relationships between departments and tax classes matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns relationship between specified department and tax class.

Department ID Tax class ID

Sets relationship between specified department and tax class.

Department-tax class relationship to be set

Deletes relationship between specified department and tax class.

Department-tax class relationship to be deleted

DiscountCouponInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Inserts cloned object to DB.

Cloning settings Cloning result Original source BaseInfo (object being cloned)

Constructor for deserialization.

Serialization info Streaming context

Constructor - Creates an empty DiscountCouponInfo object.

Constructor - Creates a new DiscountCouponInfo object from the given DataRow.

Gets object data.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Indicates whether the discount coupon is excluded or not.

ID of the discount coupon.

Value of the discount coupon.

Date until the coupon is valid.

Code of the coupon.

Indicates whether the value is flat or not.

Display name of the coupon.

Date the coupon is valid from.

Determines whether discount coupon is valid or not.

DiscountCoupon GUID.

Object last modified.

Discount coupon site ID. Set to 0 for global discount coupon.

Discount type. Used for discount calculation in the shopping cart.

Discount identifier. Used for discount calculation in the shopping cart.

Discount display name. Used for discount calculation in the shopping cart.

Discount value. Used for discount calculation in the shopping cart.

True - discount value is flat, False - discount value is relative. Used for discount calculation in the shopping cart.

True - says that discounts value is set in global main currency, False - says that discounts value is set in site main currency. Takes effect only if discount value is flat. Used for discount calculation in the shopping cart.

Number of units the discount should be applied to

Discount custom data.

Class providing DiscountCouponInfo management.

Constructor.

Returns dataset of all discount coupons matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all discount coupons matching the specified parameters.

Where condition Order by expression

Returns discount coupon with specified ID.

Discount coupon ID

Returns discount coupon with specified code. If site coupon is not found and global coupons are allowed, tries to search for global coupon with the same code.

Discount coupon code Site name

Sets (updates or inserts) specified discount coupon.

Discount coupon to be set

Deletes specified discount coupon.

Discount coupon to be deleted

Deletes discount coupon with specified ID.

Discount coupon ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all discount coupons for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all discount coupons for specified site.

Site ID

Checks dependencies, returns true if dependent.

Discount coupon ID

Recalculates coupons values using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Indicates if flat values should be recalculated Indicates if relative values should be recalculated Additional WHERE condition ID of the site which records are to be recalculated

Returns True if discount coupon is valid and can be applied to the specified shopping cart item, otherwise returns False.

Shopping cart item to which the discount couon should be applied Discount coupon data

Validates discount coupon and calculates shopping cart item unit discount after the discount coupon is applied.

Shopping cart item to which the discount coupon should be applied Discount coupon data

Indicates if user is authorized to modify specific discount coupon. For global discount coupon: 'EcommerceGlobalModify' permission is checked. For site-specific discount coupon: 'EcommerceModify' OR 'ModifyDiscounts' permission is checked.

Discount coupon to be checked Site name User to be checked

Indicates if user is authorized to modify discount coupons.

For global discount coupons (global = True): 'EcommerceGlobalModify' permission is checked. For site-specific discount coupons (global = False): 'EcommerceModify' OR 'ModifyDiscounts' permission is checked. Site name User to be checked

Returns dataset of all discount coupons matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns discount coupon with specified ID.

Discount coupon ID

Returns discount coupon with specified code. If site coupon is not found and global coupons are allowed, tries to search for global coupon with the same code.

Discount coupon code Site name

Sets (updates or inserts) specified discount coupon.

Discount coupon to be set

Deletes specified discount coupon.

Discount coupon to be deleted

Returns dataset of all discount coupons for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all discount coupons for specified site.

Site ID

Recalculates coupons values using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Indicates if flat values should be recalculated Indicates if relative values should be recalculated Additional WHERE condition ID of the site which records are to be recalculated

Returns True if discount coupon is valid and can be applied to the specified shopping cart item, otherwise returns False.

Shopping cart item to which the discount couon should be applied Discount coupon data

Validates discount coupon and calculates shopping cart item unit discount after the discount coupon is applied.

Shopping cart item to which the discount coupon should be applied Discount coupon data

DiscountLevelDepartmentInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty DiscountLevelDepartmentInfo object.

Constructor - Creates a new DiscountLevelDepartmentInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

ID of the department.

ID of the discount level.

Class providing DiscountLevelDepartmentInfo management.

Returns dataset of all relationships between discount levels and departments matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all relationships between discount levels and departments matching the specified criteria.

Where condition Order by expression

Returns relationship between specified discount level and department.

Discount level ID Department ID

Sets relationship between specified discount level and department.

Discount level-department relationship to be set

Deletes relationship between specified discount level and department.

Discount level-department relationship to be deleted

Sets relationship between specified discount level and department.

Discount level ID Department ID

Deletes relationship between specified discount level and department.

Discount level ID Department ID

Returns dataset of all relationships between discount levels and departments matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns relationship between specified discount level and department.

Discount level ID Department ID

Sets relationship between specified discount level and department.

Discount level-department relationship to be set

Deletes relationship between specified discount level and department.

Discount level-department relationship to be deleted

DiscountlLevelInfo data container class.

Table lock for loading.

Type information.

Loads the table of departments.

Constructor for deserialization.

Serialization inf Streaming context

Constructor - Creates an empty DiscountlLevelInfo object.

Constructor - Creates a new DiscountlLevelInfo object from the given DataRow.

Gets object data.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Returns true, if the discount level is assigned to the department.

Department name to check

Returns true, if the discount level is assigned to the department.

Department id

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Hashtable of departments where the discount level is assigned. DepartmentName (lowercase) is a key and DepartmentID is value.

Discount level valid from.

Discount level enabled.

Discount level name.

Discount level value.

Discount level valid to.

Determines whether discount level is valid or not.

Discount level display name.

Discount level ID.

Discount level GUID.

Object last modified.

Discount level site ID. Set to 0 for global discount level.

Discount type. Used for discount calculation in the shopping cart.

Discount identifier. Used for discount calculation in the shopping cart.

Discount display name. Used for discount calculation in the shopping cart.

Discount value. Used for discount calculation in the shopping cart.

True - discount value is flat, False - discount value is relative. Used for discount calculation in the shopping cart.

True - says that discounts value is set in global main currency, False - says that discounts value is set in site main currency. Takes effect only if discount value is flat. Used for discount calculation in the shopping cart.

Number of units the discount should be applied to

Discount custom data.

Class providing DiscountLevelInfo management.

Constructor.

Returns dataset of all discount levels matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all discount levels matching the specified parameters.

Where condition Order by expression

Returns discount level with specified ID.

Discount level ID

Returns discount level with specified name.

Discount level name Site name

Sets (updates or inserts) specified discount level.

Discount level to be set

Deletes specified discount level.

Discount level to be deleted

Deletes discount level with specified ID.

Discount level ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all discount levels for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all discount levels for specified site.

Site ID True - only enable discount levels are returned. False - both enabled and disabled discount levels are returned.

Returns True if discount level is valid and can be applied to the specified shopping cart item, otherwise returns False.

Shopping cart item to which the discount level should be applied Discount level data

Calculates shopping cart item unit discount after the specified discount level is applied.

Shopping cart item to which the discount level should be applied Discount level data

Checks dependencies, returns true if dependent.

Discount level ID

Indicates if user is authorized to modify specific discount level. For global discount level: 'EcommerceGlobalModify' permission is checked. For site-specific discount level: 'EcommerceModify' OR 'ModifyDiscounts' permission is checked.

Discount level to be checked Site name User to be checked

Indicates if user is authorized to modify discount level.

For global discount level (global = True): 'EcommerceGlobalModify' permission is checked. For site-specific discount level (global = False): 'EcommerceModify' OR 'ModifyDiscounts' permission is checked. Site name User to be checked

Returns dataset of all discount levels matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns discount level with specified ID.

Discount level ID

Returns discount level with specified name. If site discount level is not found and global discount levels are allowed, tries to search for global discount level with the same name.

Discount level name Site name

Sets (updates or inserts) specified discount level.

Discount level to be set

Deletes specified discount level.

Discount level to be deleted

Returns dataset of all discount levels for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all discount levels for specified site.

Site ID True - only enable discount levels are returned. False - both enabled and disabled discount levels are returned.

Returns True if discount level is valid and can be applied to the specified shopping cart item, otherwise returns False.

Shopping cart item to which the discount level should be applied Discount level data

Validates discount level and calculates shopping cart item unit discount after the discount level is applied.

Shopping cart item to which the discount level should be applied Discount level data

Custom E-commerce helper.

Resource name for Ecommerce.

Checks whether the user is authorized to modify site/global e-commerce configuration.

True - permission 'ConfigurationGlobalModify' is checked, False - permission 'ConfigurationGlobalModify' is checked Site name User to be checked

Checks whether the user is authorized to modify site/global e-commerce configuration.

True - permission 'ConfigurationGlobalModify' is checked, False - permission 'ConfigurationGlobalModify' is checked Site name User to be checked If true, PermissionCheckException is thrown whenever a permission check fails

Checks the specified ecommerce permission for the given user.

Permission name to be checked Site name User to be checked

Checks the specified ecommerce permission for the given user.

Permission name to be checked Site name User to be checked If true, PermissionCheckException is thrown whenever a permission check fails

Checks whether the user is authorized to access products from the specified department. Returns true if user is global admin or is granted with 'AcessAllDepartments' e-commerce module permission or he is administrator of the given department.

ID of the department User to be checked Site name

Returns 0 if specified site uses global objects based on the specified e-commerce setting, otherwise returns site ID of the specified site.

Site name One of the e-commerce settings keys which determine if specific global objects are used

Returns 0 if specified site uses global objects based on the specified e-commerce setting, otherwise returns site ID without any change.

Site ID One of the e-commerce settings keys which determine if specific global objects are used

Returns sum of all values from the specified table column.

Table Column name

Returns discount calculated from the specified price.

Price from which the discount should be calculated Discount value True - discount value is flat, False - discount value is relative

Checks if the site specified by the site ID has a main currency defined. Returns null if the main currency is defined, otherwise returns a warning message.

ID of site to check

Converts discount type string value to DiscountTypeEnum. Default value is DiscountTypeEnum.CustomDiscount.

Discounts type. 'DiscountLevel' for discount level, 'DiscountCoupon' for discount coupon, 'VolumeDiscount' for volume discount, 'CustomDiscount' for custom discount.

Converts DiscountTypeEnum to discount type string value. Default value is 'CUSTOMDISCOUNT'.

Discount type.

Tracks order conversion.

Shopping cart data

Tracks order conversion.

Shopping cart data Order conversion name. If it is set, it is used instead of the 'Order' conversion name from the settings.

Tracks registration conversion.

Name of the site the registration should be tracked for.

Tracks registration conversion.

Name of the site the registration should be tracked for. Registration conversion name. If it is set, it is used instead of the 'Registration' convertion name from the settings.

Tracks add to shopping cart conversion.

Product for which the adding to the shopping cart should be tracked.

Tracks add to shopping cart conversion.

Product for which the adding to the shopping cart should be tracked. Add to shopping cart convertion name. If it is set, it is used instead of the 'Add to shopping cart' conversion name from the settings.

Tracks conversions of all order items

Shopping cart data

Checks whether the user is authorized for given permission, returns true if so.

Permision name to check Site name User to be checked If true, PermissionCheckException is thrown whenever a permission check fails

Logs conversion with the given name and value.

Conversion name Conversion value Count of conversions to log Name of the site the conversion should be logged for

Ecommerce object type constants.

E-commerce object types - Group constant.

Code name for ecommerce suppliers.

Code name for ecommerce manufacturer.

Code name for ecommerce currencies.

Code name for payment options.

Code name for public status.

Code name for order item.

Code name for order item SKU files.

Code name for order status.

Code name for order status history.

Code name for order status history view.

Code name for internal status.

Code name for department.

Code name for department tax class.

Code name for discount coupon.

Code name for discount level.

Code name for shipping option.

Code name for exchange table.

Code name for tax classes.

Code name for tax class states.

Code name for tax class countries.

Code name for addresses.

Code name for customers.

Code name for customer list virtual object.

Code name for customers.

Code name for option categories.

Code name for orders.

Code name for order list virtual object.

Code name for SKUs.

Code name for SKUs representing product options.

Code name for SKU files.

Code name for SKUList virtual objects.

Code name for bundles.

Code name for exchange rates.

Code name for volume discounts.

Code name for shipping costs.

Code name for wishlist.

Code name for shopping cart.

Code name for shopping cart item.

Discount level department binding.

SKU Discount coupon binding.

SKU Option category binding.

SKU Tax class binding.

Shipping option Tax class binding.

User department binding.

Payment shipping binding.

ExchangeRateInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty ExchangeRateInfo object.

Constructor - Creates a new ExchangeRateInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

ID of the exchange table.

ID of the exchange rate.

ID of the target currency.

Value of the rate.

Exchange rate GUID.

Object last modified.

Class providing ExchangeRateInfo management.

Constructor.

Returns dataset of all exchange rates matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all exchange rates matching the specified parameters.

Where condition Order by expression

Returns exchange rate with specified ID.

Exchange rate ID

Sets (updates or inserts) specified exchange rate.

Exchange rate to be set

Deletes specified exchange rate.

Exchange rate to be deleted

Deletes exchange rate with specified ID.

Exchange rate ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all exchange rates of the specified exchange table.

Exchange table ID

Returns exchange rate from specified exchange table which is applied to specified currency.

Currency ID Exchange table ID

Returns valid exchange rate between main currency of the specified site and currency specified by currencyID or last invalid exchange rate if no valid rate found or 1 if no exchange rate found.

ID of the currency to which we want exchange ID of the site for which the exchange rate should be returned

Returns valid exchange rate between main currency of the specified site and currency specified by currencyID or last invalid exchange rate if no valid rate found or 1 if no exchange rate found.

ID of the currency to which we want exchange ID of the site for which the exchange rate should be returned If set to true, exchange rate between global main currency and specified site currency is calculated and returned. Has effect only when converting to site currency

Returns the value modified using the given exchange rate.

Value the exchange rate should be applied to Exchange rate value

Copies exchange rates from source table to target table. Updates only rates with same currency code. Rates in target table which does not have corresponding rate in source table will not be updated.

Id of the source exchange table Id of the target exchange table

Recalculates exchange rates values using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional WHERE condition Id of the site which records are to be recalculated

Returns dataset of all exchange rates matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns exchange rate with specified ID.

Exchange rate ID

Sets (updates or inserts) specified exchange rate.

Exchange rate to be set

Deletes specified exchange rate.

Exchange rate to be deleted

Returns dataset of all exchange rates of the specified exchange table.

Exchange table ID

Returns exchange rate from specified exchange table which is applied to specified currency.

Currency ID Exchange table ID

Returns valid exchange rate between main currency of the specified site and currency specified by currencyID or last invalid exchange rate if no valid rate found or 1 if no exchange rate found.

ID of the currency to which we want exchange ID of the site for which the exchange rate should be returned

Returns valid exchange rate between main currency of the specified site and currency specified by currencyID or last invalid exchange rate if no valid rate found or 1 if no exchange rate found.

ID of the currency to which we want exchange ID of the site for which the exchange rate should be returned If set to true, exchange rate between global main currency and specified site currency is calculated and returned. Has effect only when converting to site currency

Returns the value modified using the given exchange rate.

Value the exchange rate should be applied to Exchange rate value

Copies exchange rates from source table to target table. Updates only rates with same currency code. Rates in target table which does not have corresponding rate in source table will not be updated.

Id of the source exchange table Id of the target exchange table

Recalculates exchange rates values using the given coefficient.

Factor by which values are multiplied Number of significant digits the number should be rounded to Additional WHERE condition ID of the site which records are to be recalculated

Returns valid exchange rate between main currency of the specified site and currency specified by ID or last invalid exchange rate if no valid rate found or 1 if no exchange rate found.

ID of the currency to which we want exchange ID of the site for which the exchange rate should be returned

ExchangeTableInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Inserts cloned object to DB.

Cloning settings Cloning result Original source BaseInfo (object being cloned)

Constructor - Creates an empty ExchangeTableInfo object.

Constructor - Creates a new ExchangeTableInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Valid from.

ID of the exchange table.

Table display name.

Valid to.

Exchange table GUID.

Object last modified.

Exchange table site ID. Set to 0 for global exchange table.

Rate from global main currency to site main currency.

Class providing ExchangeTableInfo management.

Constructor.

Returns dataset of all exchange tables matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all exchange tables matching the specified parameters.

Where condition Order by expression

Returns exchange table with specified ID.

Exchange table ID

Sets (updates or inserts) specified exchange table.

Exchange table to be set

Deletes specified exchange table.

Exchange table to be deleted

Deletes exchange table with specified ID.

Exchange table ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all exchange tables for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all exchange tables for specified site.

Site ID

Returns exchange table with specified display name.

Exchange table display name Exchange table site name

For specified site returns last valid exchange table or last invalid exchange table if no valid table found or null if no exchange table found.

Site ID

For specified site returns last valid exchange table or null if no valid exchange table found.

Site ID

Indicates if exchange rate from global main currency is missing in the last valid exchange table. Returns false if site uses global currencies or global exchange rates or code of site main currency is the same as code of global main currency.

Site ID

Recalculates exchange rates from global main currency using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional WHERE condition Id of the site which records are to be recalculated

Returns valid exchange rate from global main currency to the currency of the specified site or last invalid exchange rate if no valid rate found or 1 if no exchange rate found. If site uses global currencies or global currency code equals site currency code, 1 is returned automatically.

ID of the site for which the exchange rate should be returned

Returns dataset of all exchange tables matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns exchange table with specified ID.

Exchange table ID

Sets (updates or inserts) specified exchange table.

Exchange table to be set

Deletes specified exchange table.

Exchange table to be deleted

Returns dataset of all exchange tables for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all exchange tables for specified site.

Site ID

Returns exchange table with specified display name.

Exchange table display name Exchange table site name

For specified site returns last valid exchange table or last invalid exchange table if no valid table found or null if no exchange table found.

Site ID

For specified site returns last valid exchange table or null if no valid exchange table found.

Site ID

Indicates if exchange rate from global main currency is missing in the last valid exchange table. Returns false if site uses global currencies or global exchange rates or code of site main currency is the same as code of global main currency.

Site ID

Recalculates exchange rates from global main currency using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional WHERE condition ID of the site which records are to be recalculated

Returns valid exchange rate from global main currency to the currency of the specified site or last invalid exchange rate if no valid rate found or 1 if no exchange rate found. If site uses global currencies or global currency code equals site currency code, 1 is returned automatically.

ID of the site for which the exchange rate should be returned

InternalStatusInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Fills data properties with values from given template.

Template to copy data from

Constructor - Creates an empty InternalStatusInfo object.

Constructor - Creates a new InternalStatusInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Indicates whether the status is enabled or not.

ID of the status.

Code name of the status.

Display name of the status.

InternalStatus GUID.

Object last modified.

Internal status site ID. Set to 0 for global internal status.

Class providing InternalStatusInfo management.

Constructor.

Returns dataset of all internal statuses matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all internal statuses matching the specified parameters.

Where condition Order by expression

Returns internal status with specified ID.

Internal status ID

Returns internal status with specified name.

Internal status name Site name

Sets (updates or inserts) specified internal status.

Internal status to be set

Deletes specified internal status.

Internal status to be deleted

Deletes internal status with specified ID.

Internal status ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all internal statuses for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all internal statuses for specified site.

Site ID True - only enable internal statuses are returned. False - both enabled and disabled internal statuses are returned.

Copies global internal statuses to the specified site.

ID of the target site

Checks dependencies, returns true if dependent.

Internal status ID

Returns dataset of all internal statuses matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns internal status with specified ID.

Internal status ID

Returns internal status with specified name.

Internal status name Site name

Sets (updates or inserts) specified internal status.

Internal status to be set

Deletes specified internal status.

Internal status to be deleted

Returns dataset of all internal statuses for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all internal statuses for specified site.

Site ID True - only enable internal statuses are returned. False - both enabled and disabled internal statuses are returned.

Copies site-specific status options from global status list.

Id of the site for which new statuses are to be created

Attempts to delete status. Disables status if something depends on this status.

Status to be deleted or disabled

ManufacturerInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty ManufacturerInfo object.

Constructor - Creates a new ManufacturerInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Manufacture homepage.

Manufacturer enabled.

Indicates if manufacturer is important. This flag is mostly used for filter purposes.

Manufacturer ID.

Manufacturer display name.

Manufacturer code name.

Manufacturer description.

Manufacture homepage.

Manufacturer GUID.

Object last modified.

Manufacturer site ID. Set to 0 for global manufacturer.

Manufacturer thumbnail metafile GUID.

Class providing ManufacturerInfo management.

Constructor.

Returns dataset of all manufacturers matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all manufacturers matching the specified parameters.

Where condition Order by expression

Returns manufacturer with specified ID.

Manufacturer ID

Sets (updates or inserts) specified manufacturer.

Manufacturer to be set

Deletes specified manufacturer.

Manufacturer to be deleted

Deletes manufacturer with specified ID.

Manufacturer ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all manufacturers for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all manufacturers for specified site.

Site ID True - only enable manufacturers are returned. False - both enabled and disabled manufacturers are returned.

Returns manufacturer with specified code name.

Manufacturer code name Manufacturer site name

Checks dependencies, returns true if dependent.

Manufacturer ID

Indicates if user is authorized to modify specific manufacturer. For global manufacturer: 'EcommerceGlobalModify' permission is checked. For site-specific manufacturer: 'EcommerceModify' OR 'ModifyManufacturers' permission is checked.

Manufacturer to be checked Site name User to be checked

Indicates if user is authorized to modify manufacturers.

For global manufacturers (global = True): 'EcommerceGlobalModify' permission is checked. For site-specific manufacturers (global = False): 'EcommerceModify' OR 'ModifyManufacturers' permission is checked. Site name User to be checked

Returns dataset of all manufacturers matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns manufacturer with specified ID.

Manufacturer ID

Sets (updates or inserts) specified manufacturer.

Manufacturer to be set

Deletes specified manufacturer.

Manufacturer to be deleted

Returns dataset of all manufacturers for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all manufacturers for specified site.

Site ID True - only enable manufacturers are returned. False - both enabled and disabled manufacturers are returned.

Returns manufacturer with specified code name.

Manufacturer code name Manufacturer site name

OptionCategoryInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates a new OptionCategoryInfo object from the given DataClass.

Source category info If true, source data are kept in the object

Constructor - Creates an empty OptionCategoryInfo object.

Constructor - Creates a new OptionCategoryInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Category Display Name (simple text or localizable string).

Category Code Name.

Category ID.

Category site ID. Set to 0 for global category.

Code name of form control used for selecting product options.

Category SKU ID. Set to 0 for the shared category.

Indicates if the category is shared among all the products or belongs only to the single product specified by the CategorySKUID

Indicates if category is global or site-specific.

Type of the category

Type of the control which is used for configuring product options of the category

Category default options.

Category description (simple text or localizable string).

Default record text (simple text or localizable string).

Indicates whether option category is enabled.

CategoryOption GUID.

Object last modified.

Indicates whether the option price should be displayed with option.

Maximum length of the text product option text. It has no effect, if the category has no text product option.

Class providing OptionCategoryInfo management.

Constructor.

Returns dataset of all option categories matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all option categories matching the specified parameters.

Where condition Order by expression

Returns option category with specified ID.

Option category ID

Returns option category with specified name.

Option category name Site name

Sets (updates or inserts) specified option category.

Option category to be set

Deletes specified option category.

Option category to be deleted

Deletes option category with specified ID.

Option category ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all option categories for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all option categories for specified site.

Site ID

Returns DataSet with all option categories which are assigned to the specified SKU.

SKU ID True - only enabled option categories are included, False - all option categories are included

Checks option category dependencies. Returns TRUE if category is depended, otherwise returns FALSE.

Option category ID

Indicates if user is authorized to modify specific option category. For global option category: 'EcommerceGlobalModify' permission is checked. For site-specific manufacturer: 'EcommerceModify' OR 'ModifyProducts' permission is checked.

Option category to be checked Site name User to be checked

Indicates if user is authorized to modify option categories.

For global option categories (global = True): 'EcommerceGlobalModify' permission is checked. For site-specific option categories (global = False): 'EcommerceModify' OR 'ModifyProducts' permission is checked. Site name User to be checked

Returns product option category type as OptionCategoryTypeEnum from its string representation.

Option category type represented by the string

Returns product option category type as string from its OptionCategoryTypeEnum representation.

Option category type represented by the OptionCategoryTypeEnum

Returns product option category selection type as OptionCategorySelectionTypeEnum from its string representation.

Option category selection type represented by the string

Returns product option category selection type as string from its OptionCategorySelectionTypeEnum representation.

Option category selection type represented by the OptionCategorySelectionTypeEnum

Returns dataset of all option categories matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns option category with specified ID.

Option category ID

Returns option category with specified name.

Option category name Site name

Sets (updates or inserts) specified option category.

Option category to be set

Deletes specified option category.

Option category to be deleted

Returns dataset of all option categories for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns DataSet with all option categories which are assigned to the specified SKU.

SKU ID True - only enabled option categories are included, False - all option categories are included

Checks option category dependencies. Returns TRUE if category is depended, otherwise returns FALSE.

Option category ID

Type of control to select product options.

DropDownList.

RadioButtons in vertical layout.

RadioButtons in horizontal layout.

Checkboxes in vertical layout.

Checkboxes in horizontal layout.

Text box.

Text area.

Form control

OrderInfo data container class.

Type information.

Order custom data.

Payment result.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty OrderInfo object.

Constructor - Creates a new OrderInfo object from the given DataRow.

Constructor - Creates a new OrderInfo object from serialized data.

Serialization data Context

Gets object data.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Registers the properties of this object

Order ID.

Order payment option ID.

Order site ID.

Order total tax.

Order shipping address ID.

Order invoice number.

Order currency ID.

Order shipping option ID.

Order invoice.

Order note.

Order created by user ID.

Order billing address ID.

Country ID.

Order customer ID.

Order status ID.

Order total price.

Order total price in main currency.

Order total shipping.

Order date.

Order payment result.

Order discount coupon ID.

Order company address ID.

Order tracking number.

Order custom data.

Order GUID.

Object last modified.

Order is paid.

Culture of the order.

Class providing OrderInfo management.

Constructor.

Returns dataset of all orders matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all orders matching the specified parameters.

Where condition Order by expression

Returns order with specified ID.

Order ID

Sets (updates or inserts) specified order.

Order to be set

Deletes specified order.

Order to be deleted

Deletes order with specified ID.

Order ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all orders for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all orders for specified site.

Site ID

Returns the order list joined with order status, and the customer data.

Where condition Order by expression

Returns the order list joined with order status, and the customer data.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns the order list joined with order status, and the customer data.

Query parameters Where condition to filter orders Order by statement Specifies number of returned orders Data columns to return If true, binary data are returned in the result Index of first record to get Maximum number of orders to get. If maxRecords is zero or less, all orders are returned (no paging is used) Returns total number of available orders

Returns invoice number generated from given shopping cart data.

Shopping cart info object to generate invoice number for

Returns html code that represents invoice of order specified by ID.

Order ID

Returns html code that represents invoice of order loaded in the given shopping cart.

Shopping cart with order data

Returns html code that represents address. Used for generating of invoice.

Address ID

Returns html code that represents payment option. Used for generating of invoice.

Payment option ID

Returns html code that represents shipping option. Used for generating of invoice.

Shipping option ID

Returns html code that represents invoice number. Used for generating of invoice.

Order data

Returns html code that represents date of order. Used for generating of invoice.

Order data

Returns html code that represents note of order. Used for generating of invoice.

Order data

Returns html code that represents product list. Used for generating of invoice.

Shopping cart data

Returns html code that represents total price of order. Used for generating of invoice.

Price value Currency to use

Returns html code that represents info about used taxes. Used for generating of invoice.

Table with the tax summary Currency data

Returns html code that represents info about customer taxregistrationID. Used for generating of invoice.

Customer data

Returns html code that represents info about customer taxregistrationID. Used for generating of invoice.

Customer data

Returns html code that represents total shipping of order. Used for generating of invoice.

Price value Currency to use

Creates the macro resolver for the given shopping cart.

Shopping data

Sends order notification to customer.

Shopping cart data

Sends order notification to customer.

Shopping cart data Name of the template which is used for e-mail. If null or empty, 'Ecommerce.OrderNotificationToCustomer' template is used

Sends order notification to administrator.

Shopping cart data

Sends order notification to administrator.

Shopping cart data Name of the template which is used for e-mail. If null or empty, 'Ecommerce.OrderNotificationToAdmin' template is used

Sends order payment notification to customer.

Shopping cart data

Sends order payment notification to customer.

Shopping cart data Name of the template which is used for e-mail. If null or empty, 'Ecommerce.OrderPaymentNotificationToCustomer' template is used

Sends order payment notification to administrator.

Shopping cart data

Sends order payment notification to administrator.

Shopping cart data Name of the template which is used for e-mail. If null or empty, 'Ecommerce.OrderPaymentNotificationToAdmin' template is used

Sends order status notification to customer.

Shopping cart data

Sends order status notification to customer.

Shopping cart data Name of the template which is used for e-mail. If null or empty, 'Ecommerce.OrderStatusNotificationToCustomer' template is used

Sends order status notification to administrator.

Shopping cart data

Sends order status notification to administrator.

Shopping cart data Name of the template which is used for e-mail. If null or empty, 'Ecommerce.OrderStatusNotificationToAdmin' template is used

Recalculates order prices expressed in main currency using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional WHERE condition ID of the site which records are to be recalculated

Returns dataset of all orders matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns order with specified ID.

Order ID

Sets (updates or inserts) specified order.

Order to be set

Deletes specified order.

Order to be deleted

Returns dataset of all orders for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns the order list joined with order status, and the customer data.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns the order list joined with order status, and the customer data.

Query parameters Where condition to filter orders Order by statement Specifies number of returned orders Data columns to return If true, binary data are returned in the result Index of first record to get Maximum number of orders to get. If maxRecords is zero or less, all orders are returned (no paging is used) Returns total number of available orders

Recalculates order prices expressed in main currency using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Where condition ID of the site which records are to be recalculated

Returns invoice number generated from given shopping cart data.

Shopping cart info object

Updates order status history and sends notification emails about order status change.

Order data ID of the status before change. Don't care if newOrder == true True - it is a new order, False - it is an existing order

Process order items of given order according to order is paid change.

Order

Process user's membership according to given parameters.

Order Order item SKU User Date and time to use as current date and time value

Process e-product according to given parameters.

Order Order item SKU Date and time to use as current date and time value

Returns html code that represents invoice of order specified by ID.

Order ID

Returns html code that represents invoice of order loaded in the given shopping cart.

Shopping cart with order data

Returns html code that represents address. Used for generating of invoice.

Address ID

Returns html code that represents payment option. Used for generating of invoice.

Payment option ID

Returns html code that represents shipping option. Used for generating of invoice.

Shipping option ID

Returns html code that represents invoice number. Used for generating of invoice.

Order data

Returns html code that represents date of order. Used for generating of invoice.

Order data

Returns html code that represents note of order. Used for generating of invoice.

Order data

Returns html code that represents product list. Used for generating of invoice.

Shopping cart data

Returns html code that represents total price of order. Used for generating of invoice.

Price value Currency to use

Returns html code that represents info about used taxes. Used for generating of invoice.

Table with the tax summary Currency data

Returns html code that represents info about customer taxregistrationID. Used for generating of invoice.

Customer data

Returns html code that represents info about customer taxregistrationID. Used for generating of invoice.

Customer data

Returns html code that represents total shipping of order. Used for generating of invoice.

Price value Currency to use

Creates the macro resolver for the given shopping cart.

Shopping data

Sends order notification to customer.

Shopping cart data Name of the template which is used for e-mail. If null or empty, 'Ecommerce.OrderNotificationToCustomer' template is used

Sends order notification to administrator.

Shopping cart data Name of the template which is used for e-mail. If null or empty, 'Ecommerce.OrderNotificationToAdmin' template is used

Sends order payment notification to customer.

Shopping cart data Name of the template which is used for e-mail. If null or empty, 'Ecommerce.OrderPaymentNotificationToCustomer' template is used

Sends order payment notification to administrator.

Shopping cart data Name of the template which is used for e-mail. If null or empty, 'Ecommerce.OrderPaymentNotificationToAdmin' template is used

Sends order status notification to customer.

Shopping cart data Name of the template which is used for e-mail. If null or empty, 'Ecommerce.OrderStatusNotificationToCustomer' template is used

Sends order status notification to administrator.

Shopping cart data Name of the template which is used for e-mail. If null or empty, 'Ecommerce.OrderStatusNotificationToAdmin' template is used

Sends order notification to customer.

Shopping cart info object Name of the e-mail template which should be used for creating an e-mail Name of the e-mail template which is used if primary template is not specified E-mail default subject. It is used if template subject is not specified True - it is a notification to customer. False - it is a notification to administrator Source of the event which is logged when sending fails

Gets event log provider instance.

OrderItemInfo data container class.

Type information.

Order item custom data.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty OrderItemInfo object.

Constructor - Creates a new OrderItemInfo object from the given DataRow.

Constructor - Creates a new OrderItemInfo object from serialized data.

Serialization data Context

Gets object data.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Registers the properties of this object

Price of the item per unit, corresponds to the price of the related SKU.

If set, it is used instead of the OrderItemUnitPrice in price calculation process. It is set only when order item represents donation. Then it is amount of donation.

Total order item price in main currency.

ID of the order.

ID of the order item.

Name of the order item.

ID of the SKU for this order item.

Number of units within the order.

Order item unique identifier. Order item means collection of the product and its selected product options.

Unique identifier of the parent order item. When set current product is a product option, otherwise it is a product.

Unique identifier of parent bundle product. If set, this product is a bundle item.

Order item custom data.

Object last modified.

Order item is private.

Order item valid to date and time.

Indicates if customer is to be notified in advance about expiration of his order item.

Associated SKU object.

Text assigned to the order item.

Class providing OrderItemInfo management.

Returns dataset of all order items matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all order items matching the specified parameters.

Where condition Order by expression

Returns order item with specified ID.

Order item ID

Sets (updates or inserts) specified order item.

Order item to be set

Deletes specified order item.

Order item to be deleted

Deletes specified order item. Allows to return ordered items back to inventory.

Order item to be deleted When true, items are returned back to inventory.

Deletes order item with specified ID.

Order item ID

Returns order item created form shopping cart item data.

Shopping cart item.

Returns dataset of all order items for specified order.

Order ID

Returns dataset of all expiring order items matching given parameters along with additional relevant information.

Number of days before order item expiration Site ID. Set to 0 to get expiring order items on all sites. Additional where condition

Returns dataset of all expiring order items matching given parameters along with additional relevant information.

Number of days before order item expiration Site ID. Set to 0 to get expiring order items on all sites. Additional where condition Get only records with send notification flag set to true.

Returns dataset of order items representing donation products matching given where condition along with related order, customer and SKU information.

Where condition Order by

Returns dataset of order items representing donation products matching given where condition along with related order, customer and SKU information.

Where condition Order by Top N Columns

Recalculates order items using given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional WHERE condition

Delete all order items for specified order.

Order ID

Returns dataset of all order items matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns order item with specified ID.

Order item ID

Sets (updates or inserts) specified order item.

Order item to be set

Deletes specified order item.

Order item to be deleted

Deletes specified order item. Allows to return ordered items back to inventory.

Order item to be deleted. When true, items are returned back to inventory.

Returns order item created form shopping cart item data.

Shopping cart item.

Returns dataset of all order items for specified order.

Order ID

Returns dataset of all expiring order items matching given parameters along with additional relevant information.

Number of days before order item expiration Site ID. Set to 0 to get expiring order items on all sites. Additional where condition Get only records with send notification flag set to true.

Returns dataset of order items representing donation products matching given where condition along with related order, customer and SKU information.

Where condition Order by Top N Columns

Recalculates order items using given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional WHERE condition

Delete all order items for specified order.

Order ID

OrderStatusInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Inserts cloned status to DB.

Cloning settings Cloning result Original source BaseInfo (object being cloned)

Fills data properties with values from given template.

Template to copy data from

Constructor - Creates an empty OrderStatusInfo object.

Constructor - Creates a new OrderStatusInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Order of the status.

ID of the status.

Indicates whether the status is enabled or not.

Display name of the status.

Code name of the status.

Status color in hexa format (#xxxxxx).

Order status GUID.

Order status last modified.

Indicates if notification should be send to the customer and administrator when order status is changed to this status.

Order status site ID. Set to 0 for global order status.

Order status is paid.

Class providing OrderStatusInfo management.

Constructor.

Returns dataset of all order statuses matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all order statuses matching the specified parameters.

Where condition Order by expression

Returns order status with specified ID.

Order status ID

Returns order status with specified name.

Order status name Site name

Sets (updates or inserts) specified order status.

Order status to be set

Deletes specified order status.

Order status to be deleted

Deletes order status with specified ID.

Order status ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all order statuses for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all order statuses matching the specified parameters.

ID of the site the order statuses should be retrieved from. If set to 0, global order statuses are retrieved True - only enabled order statuses from the specified site are returned. False - all site order statuses are returned

Checks the order status dependencies. Returns true if there are depending objects.

Status ID

Moves status up (decreases its order).

ID of status to move

Moves status down (increases its order).

ID of status to move

Returns order of last status item for given site.

Id of the site (0 for global)

Returns first enabled order status in order progress for given site.

Returns next enabled order status in order progress.

Current order status id

Returns previous enabled order status in order progress.

Current order status id

Copies site-specific status options from global status list.

Id of the site for which new statuses are to be created

Returns dataset of all order statuses matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns order status with specified ID.

Order status ID

Returns order status with specified name.

Order status name Site name

Sets (updates or inserts) specified order status.

Order status to be set

Deletes specified order status.

Order status to be deleted

Returns dataset of all order statuses for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all order statuses matching the specified parameters.

ID of the site the statuses should be retrieved from. If set to 0, global order statuses are retrieved True - only enabled statuses from the specified site are returned. False - all site statuses are returned

Moves status up (decreases its order).

ID of status to move

Moves status down (increases its order).

ID of status to move

Initializes the order of statuses in site scope. Site is specified by status id.

Id of the status for obtaining site id

Returns order of last status item for given site.

Id of the site (or 0 for global)

Returns first enabled order status in order progress.

Returns next enabled status in order progress.

Current order status id

Returns previous enabled status in order progress.

Current order status id

Copies site-specific status options from global status list.

Id of the site for which new statuses are to be created

Attempts to delete status info. Disables status if something depends on this status.

Status to delete or disable

Logs synchronization tasks when order status order was changed.

ID of the moved status

OrderStatusUserInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty OrderStatusUserInfo object.

Constructor - Creates a new OrderStatusUserInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

ID of the order.

To status ID.

Changed by user ID.

Note of the order status.

Date of the change.

Order status user ID.

From status ID.

Class providing OrderStatusUserInfo management.

Returns dataset of all order status history items matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all order status history items matching the specified parameters.

Where condition Order by expression

Returns order status history item with specified ID.

Order status history item ID

Sets (updates or inserts) specified order status history item.

Order status history item to be set

Deletes specified order status history item.

Order status history item to be deleted

Deletes order status history item with specified ID.

Order status history item ID

Returns the dataset of order status history for specified order.

Order ID

Returns the dataset of order status history for specified order (both statuses and user joined).

Order ID

Returns the dataset of order status history (both statuses and user joined).

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all order status history items matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns order status history item with specified ID.

Order status history item ID

Sets (updates or inserts) specified order status history item.

Order status history item to be set

Deletes specified order status history item.

Order status history item to be deleted

Returns dataset containing order status history for given oredrId.

ID of the order to get history for

Returns the dataset of order status history for specified order (both statuses and user joined).

Order ID

Returns the dataset of order status history (both statuses and user joined).

where condition order by top n columns

PaymentOptionInfo data container class.

Type information.

Constructor for deserialization.

Serialization inf Streaming context

Constructor - Creates an empty PaymentOptionInfo object.

Constructor - Creates a new PaymentOptionInfo object from the given DataRow.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Returns true, if the payment option is in the specified shipping option.

Shipping option ID

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

ID of the payment option.

Code name of the payment option.

Payment option site ID. Set to 0 for global payment option.

Indicates whether the payment option is enabled or not.

Payment option - Payment gate url.

Code name of the payment option.

Payment option description.

Payment gateway assembly name.

Payment gateway class name.

ID of the status which is considered to be "payment successful" status.

ID of the status which is considered to be "payment failed" status.

Payment option GUID.

Object last modified.

Allow payment option to be selected if order does not need shipping.

Payment option thumbnail metafile GUID.

Class providing PaymentOptionInfo management.

Constructor.

Returns dataset of all payment options matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all payment options matching the specified parameters.

Where condition Order by expression

Returns payment option with specified ID.

Payment option ID

Returns payment option with specified name.

Payment option name Site name

Sets (updates or inserts) specified payment option.

Payment option to be set

Deletes specified payment option.

Payment option to be deleted

Deletes payment option with specified ID.

Payment option ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all payment options for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all payment options matching the specified parameters.

ID of the site the options should be retrieved from. If set to 0, global payment options are retrieved True - only enabled payment options from the specified site are returned. False - all site options are returned

Returns dataset of payment options bound to specified shipping option.

Id of the sipping option True - only enabled payment options from the specified shipping option are returned. False - all options bound to shipping are returned

Returns URL to payment gateway.

Shopping cart object

Resolves macros of payment gateway URL.

URL to resolve Cart object

Checks dependencies, returns true if dependent.

Payment option ID

Returns dataset of all payment options matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns payment option with specified ID.

Payment option ID

Returns payment option with specified name.

Payment option name Site name

Sets (updates or inserts) specified payment option.

Payment option to be set

Deletes specified payment option.

Payment option to be deleted

Returns dataset of all payment options for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all payment options matching the specified parameters.

ID of the site the options should be retrieved from. If set to 0, global payment options are retrieved True - only enabled payment options from the specified site are returned. False - all site options are returned

Returns dataset of payment options bound to specified shipping option.

Id of the sipping option True - only enabled payment options from the specified shipping option are returned. False - all options bound to shipping are returned

Returns URL to payment gateway.

Shopping cart object

Resolves macros of payment gateway URL.

URL to resolve Cart object

Class representing payment result item (= one payment result xml node).

Creates payment result item from Xml node.

Creates empty payment result item.

Payment result item header text.

Payment result item code name.

Payment result item value - inner interpretation.

Payment result item value text interpretation - it is visible to user.

PaymentShippingInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty PaymentShippingInfo object.

Constructor - Creates a new PaymentShippingInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

ID of the payment option.

ID of the shipping option.

Class providing PaymentShippingInfo management.

Returns dataset of all relationships between payment options and shipping options matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all relationships between payment options and shipping options matching the specified criteria.

Where condition Order by expression

Returns relationship between specified payment option and shipping option.

Payment option ID Shipping option ID

Sets relationship between specified payment option and shipping option.

Payment option-shipping option relationship to be set

Deletes relationship between specified payment option and shipping option.

Payment option-shipping option relationship to be deleted

Sets relationship between specified payment option and shipping option.

Payment option ID Shipping option ID

Deletes relationship between specified payment option and shipping option.

Payment option ID Shipping option ID

Returns dataset of all relationships between payment options and shipping options matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns relationship between specified payment option and shipping option.

Payment option ID Shipping option ID

Sets relationship between specified payment option and shipping option.

Payment option-shipping option relationship to be set

Deletes relationship between specified payment option and shipping option.

Payment option-shipping option relationship to be deleted

PayPal payment result.

Returns paypal payment status according to the returned status string from the PayPal payment gateway.

Payment status string returned from the PayPal payment gateway

Sets paypal payment status according to the returned status from tha paypal payment gateway.

Payment status string returned from the paypal payment gateway

Returns paypal payment status enumeration from payment result status string.

Creates base payment result info object + add PayPal payment result properties.

PayPal payment status.

TRUE - payment was verified by IPN (Instant payment notification) successfully, payment is VALID. FALSE - payment verification by IPN failed, payment is INVALID.

PayPal payment status.

Payment status is not known.

Payment has been completed, and the funds have been added successfully to merchant's account balance.

A reversal has been canceled. For example, merchant won a dispute with the customer, and the funds for the transaction that was reversed have been returned to merchant.

When merchant denied the payment. This happens only if the payment was previously pending.

This authorization has expired and cannot be captured.

The payment has failed. This happens only if the payment was made from merchant customer's bank account.

The transaction is in process of authorization and capture.

The payment is pending.

The payment has been accepted.

The payment was refunded.

The payment was reversed due to a chargeback or other type of reversal. The funds have been removed from merchant's account balance and returned to the buyer.

This authorization has been voided.

Products data source server control.

OnInit override, register OnFilter change event.

OnFilterChange handler.

Gets datasource from DB.

Dataset as object

Gets the default cache dependencies for the data source.

Gets Datasource object.

Indicates if the comments should be retrieved according to document filter settings.

Path of the documents to be displayed. /% selects all documents.

Culture code, such as en-us.

Indicates if the documents from the default culture version should be alternatively used.

Indicates if only published documents should be displayed.

Relative level of child documents that should be selected. -1 selects all child documents.

Gets or sets the where condition for blog posts.

PublicStatusInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Fills data properties with values from given template.

Template to copy data from

Constructor - Creates an empty PublicStatusInfo object.

Constructor - Creates a new PublicStatusInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Code name of the status.

ID of the status.

Indicates whether the status is enabled or not.

Display name of the status.

PublicStatus GUID.

Object last modified.

Public status site ID. Set to 0 for global public status.

Class providing PublicStatusInfo management.

Constructor.

Returns dataset of all public statuses matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all public statuses matching the specified parameters.

Where condition Order by expression

Returns public status with specified ID.

Public status ID

Returns public status with specified name.

Public status name Site name

Sets (updates or inserts) specified public status.

Public status to be set

Deletes specified public status.

Public status to be deleted

Deletes public status with specified ID.

Public status ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all public statuses for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all public statuses matching the specified parameters.

ID of the site the public statuses should be retrieved from. If set to 0, global public statuses are retrieved True - only enabled public statuses from the specified site are returned. False - all site public statuses are returned

Checks the public status dependencies. Returns true if there are depending objects.

Status ID

Copies site-specific status options from global status list.

Id of the site for which new statuses are to be created

Returns dataset of all public statuses matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns public status with specified ID.

Public status ID

Returns public status with specified name.

Public status name Site name

Sets (updates or inserts) specified public status.

Public status to be set

Deletes specified public status.

Public status to be deleted

Returns dataset of all public statuses for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all public statuses matching the specified parameters.

ID of the site the statuses should be retrieved from. If set to 0, global public statuses are retrieved True - only enabled statuses from the specified site are returned. False - all site statuses are returned

Copies site-specific status options from global status list.

Id of the site for which new statuses are to be created

Attempts to delete status info. Disables status if something depends on this status.

Status to delete or disable

ShippingOptionInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor for deserialization.

Serialization info Streaming context

Constructor - Creates an empty ShippingOptionInfo object.

Constructor - Creates a new ShippingOptionInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Shipping option site ID. Set to 0 for global shipping option.

Shipping option display name.

Shipping option description.

Shipping option charge.

ID of the shipping option.

Code name of the shipping option.

Indicates whether the shipping option is enabled or not.

ShippingOption GUID.

Object last modified.

Shipping option thumbnail metafile GUID.

Class providing ShippingOptionInfo management.

Constructor.

Returns dataset of all shipping options matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all shipping options matching the specified parameters.

Where condition Order by expression

Returns shipping option with specified ID.

Shipping option ID

Returns shipping option with specified name.

Shipping option name Site name

Sets (updates or inserts) specified shipping option.

Shipping option to be set

Deletes specified shipping option.

Shipping option to be deleted

Deletes shipping option with specified ID.

Shipping option ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all shipping options for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all shipping options matching the specified parameters.

ID of the site the options should be retrieved from. If set to 0, global shipping options are retrieved True - only enabled shipping options from the specified site are returned. False - all site options are returned

Returns dataset of all shipping options suitable for specified shopping cart.

Shopping cart info object True - only enabled shipping options from the specified site are returned. False - all site options are returned

Checks dependencies, returns true if dependent.

Shipping option ID

Returns weight formated according site specific weight format string. If no format string speciffied, uses x.xx format instead.

Weight Name of the site for obtaining format string

Returns shipping price or zero according to site store shipping free limit.

Shipping price Total order price Site store shipping free limit

Calculates shipping cost for the given shopping cart. Shipping free limit is applied. Shipping taxes are not included. Result is in site main currency.

Shopping cart object

Calculates tax value of the shipping option for the given shopping cart. Result is in site main currency.

Shopping cart object.

Calculates total shipping for the given shopping cart. Shipping taxes are included. Result is site main currency.

Shopping cart object

Recalculates options charges and their shipping costs using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional WHERE condition ID of the site which records are to be recalculated

Recalculates shipping free limit for specified site using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to ID of the site which limit is to be recalculated

Check if shopping cart needs shipping, return true if it does.

Shopping cart object

Returns dataset of all shipping options matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns shipping option with specified ID.

Shipping option ID

Returns shipping option with specified name.

Shipping option name Site name

Sets (updates or inserts) specified shipping option.

Shipping option to be set

Deletes specified shipping option.

Shipping option to be deleted

Returns dataset of all shipping options for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all shipping options matching the specified parameters.

ID of the site the options should be retrieved from. If set to 0, global shipping options are retrieved True - only enabled shipping options from the specified site are returned. False - all site options are returned

Returns dataset of all shipping options suitable for specified shopping cart.

Shopping cart info object True - only enabled shipping options from the specified site are returned. False - all site options are returned

Returns weight formated according site specific weight format string. If no format string speciffied, uses x.xx format instead.

Weight Name of the site for obtaining format string

Returns shipping price or zero according to site store shipping free limit.

Shipping price in site main currency Total order price in site main currency Site store shipping free limit

Calculates shipping cost for the given shopping cart. Shipping free limit is applied. Shipping taxes are not included. Result is in site main currency.

Shopping cart object

Calculates tax value of the shipping option for the given shopping cart. Result is in site main currency.

Shopping cart object.

Calculates total shipping for the given shopping cart. Shipping taxes are included. Result is site main currency.

Shopping cart object

Recalculates options charges and their shipping costs using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional WHERE condition ID of the site which records are to be recalculated

Recalculates shipping free limit for specified site using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to ID of the site which limit is to be recalculated

Check if shopping cart needs shipping, return true if it does.

Shopping cart

Class providing settings for prices recalculations.

Indicates whether exchange rates will be recalculated.

Indicates whether exchange rates from global main currency to site-specific main currency will be recalculated.

Indicates whether product prices will be recalculated.

Indicates whether flat taxes will be recalculated.

Indicates whether flat discount coupon values will be recalculated.

Indicates whether flat volume discount will be recalculated.

Indicates whether customer credit and its history will be recalculated.

Indicates whether shipping options charges and costs will be recalculated.

Indicates whether prices in used in products will be recalculated.

Indicates whether free shipping limit will be recalculated.

Indicates whether order total price and ordet items' prices in main currency will be recalculated.

Provides an ITask interface to send notifications to users about their expiring e-product downloads. If started as global scheduled task, it sends notifications about expiring e-products on all sites.

Executes the task.

Task to process

Returns notification email message according to given notification data.

Notification data

Get macro resolver for expiring e-products notification email.

Notification data

Represents e-product expiration notification data.

Customer e-mail where the notification is sent

Table with customer expiring e-products

Provides an ITask interface to delete old shopping carts.

Executes the publish action.

Task to process

ShoppingCartInfo data container class.

Not known double constant.

Not known integer constant.

Type information.

Shopping cart custom data object

Constructor - Creates an empty ShoppingCartInfo object. Use ShoppingCartInfo.CreateShoppingCartInfo(int siteId) instead!

Constructor - Creates an empty ShoppingCartInfo object.

Constructor - Creates a new ShoppingCartInfo object from the given DataRow.

Returns new ShoppingCartInfo object created from the given DataRow.

DataRow with shopping cart data

Returns new empty ShoppingCartInfo object.

Site ID

Returns new ShoppingCartInfo object created from deserialized data.

Data for deserialization the ShoppingCartInfo object should be created from Streaming context

Gets object data.

Serialization info Serialization context

Constructor for deserialization.

Serialization info Streaming context

Register the custom properties

Adds product (and its product options) to the shopping cart object. If such product configuration already exists in the shopping cart, only its quantity is updated. Added/updated shopping cart item is returned.

Parameters of the shopping cart item which should be used to perform the adding or updating.

Returns shopping cart item from the shopping cart object.

Shopping cart item ID

Returns shopping cart item from the shopping cart object.

Shopping cart item GUID

Removes shopping cart item and its product options from the shopping cart object.

Shopping cart item ID

Removes shopping cart item and its product options from the shopping cart object.

Shopping cart item GUID

Invalidates all shopping cart calculations.

Invalidates shopping cart exchange rates.

Returns price in shopping cart currency.

Price in site main currency to which the exchange rate should be applied

Returns price in shopping cart currency.

Price to which the exchange rate should be applied True - exchange rate for global items is used (price is expected in global main currency), False - exchange rate for site items is used (price is expected in site main currency).

Returns price in main currency of the site the shopping cart belongs to.

Price in global main currency to which the exchange rate should be applied

Returns rounded price using the shopping cart currency settings.

Price to be rounded

Returns formatted price using the shopping cart currency formatting string.

Price to be formatted

Returns formatted price using the shopping cart currency formatting string.

Price to be formatted True - price is rounded using the shopping cart currency settings before formatting

Invalidates discount levels related data.

Invalidates specific calculations. Content taxes and shipping taxes are not cleared.

True - Shopping cart content table is cleared True - Shopping cart content taxes table is cleared True - Shopping cart shipping taxes table is cleared True - Shopping cart totals (discounts, taxes, prices and shipping) are cleared

Invalidates specific calculations.

True - Shopping cart content table is cleared, shopping cart items and discounts indicators are invalidated True - Shopping cart content taxes table is cleared True - Shopping cart shipping taxes table is cleared True - Shopping cart totals (discounts, taxes, prices and shipping) are cleared True - Shopping cart content taxes are cleared True - Shopping cart shipping taxes are cleared True - sum of all shopping cart items' units is set to zero

Owner of the shopping cart. It is null if customer is anonymous.

Customer information.

Customer's global discount level.

Discount coupon information. It is null if no discount coupon is used.

Selected currency.

Selected payment method.

Selected shipping option.

Shopping cart ID.

Shopping cart site ID.

Shopping cart shipping option ID.

Shopping cart payment option ID.

Shopping cart customer ID.

ID of the registered user the shopping cart belongs to.

Shopping cart billing address ID.

Shopping cart shipping address ID.

Shopping cart company address ID.

Shopping cart discount coupon ID.

Shopping cart currency ID.

Shopping cart note.

Shopping cart GUID.

Date and time when the shopping cart was last updated.

Shopping cart custom data.

Order data. Loaded when the shopping cart is created from an existing order, otherwise it is null.

Customer information.

Owner of the shopping cart. It is null if customer is anonymous.

Customer's global discount level.

Customer's discount level for the site the shopping cart belongs to.

Discount coupon information. It is null if no discount coupon is used.

Selected shipping option.

Selected currency.

Selected payment method.

Taxes which should be applied to the shopping cart items.

Taxes which should be applied to the selected shipping option.

Table with the shopping cart items.

Table with the summary of the taxes which were applied to the shopping cart items.

Table with the summary of the taxes which were applied to the selected shipping option.

Total price of the shopping cart in shopping cart currency. All discounts, taxes and shipping are included.

Total price of the shopping cart in site main currency. All discounts, taxes and shipping are included.

Total price of all shopping cart items in shopping cart currency. Items discounts and taxes are included.

Total price of all shopping cart items in site main currency. Items discounts and taxes are included.

Discount which is applied to the items total price. It is in shopping cart currency.

Discount which is applied to the items total price. It is in site main currency.

Total tax which is applied to all shopping cart items altogether. It is in shopping cart currency.

Total tax which is applied to all shopping cart items altogether. It is in site main currency.

Shipping cost without taxes. Shipping free limit is applied. Value is in shopping cart currency.

Shipping cost without taxes. Shipping free limit is applied. Value is in site main currency.

Total shipping in shopping cart currency. Shipping taxes are included.

Total shipping in site main currency. Shipping taxes are included.

Rounded total price in shopping cart currency. It is rounded according to the shopping cart currency rules.

Rounded total price in site main currency. It is rounded according to the site main currency rules.

Exchange rate from site main currency to shopping cart currency. This exchange rate is applied to all site items (products, discounts, taxes, shipping option) which are present in the shopping cart to express their price in shopping curt currency.

Exchange rate from global main currency to shopping cart currency. This exchange rate is applied to all global items (products, discounts, taxes, shipping option) which are present in the shopping cart to express their price in shopping curt currency. If site uses global currencies, it is equal to exchange rate from site main currency to shopping cart currency.

Exchange rate from global main currency to site main currency. This exchange rate is applied to all global items (products, discounts, taxes, shipping option) which are present in the shopping cart to express their price in site main currency. If site uses global currencies, it is equal to 1.

List of shopping cart items.

Sum of all shopping cart items' units, bundle items and product options are not included.

Payment gateway custom data.

Total weight of shopping cart items.

Name of the site to which the shopping cart belongs.

Indicates if shopping cart object is created from order. It is set automatically when shopping cart object is created by GetShoppingCartInfoFromOrder method.

ID of the order to which the shopping cart belongs or from which the shopping cart was created.

TRUE - some discount is applied at least to one shopping cart item, FALSE - no discount is applied to shopping cart items.

TRUE - discount coupon is applied at least to one shopping cart item, otherwise FALSE.

Indicates if private data were cleared from this shopping cart object. It is set automatically when shopping cart private data are cleared by ClearShoppingCartPrivateData method.

Shopping cart order culture (or culture of the order user created using the shopping cart).

Country ID.

State ID.

Indicates whether shopping cart items should be checked for availability.

Indicates whether some shopping cart product items are not available.

Class providing ShoppingCartInfo management.

Returns dataset of all shopping carts matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all shopping carts matching the specified parameters.

Where condition Order by expression

Returns shopping cart with specified ID.

Shopping cart ID

Returns shopping cart with specified GUID.

Shopping cart GUID

Sets (updates or inserts) specified shopping cart.

Shopping cart to be set

Deletes specified shopping cart.

Shopping cart to be deleted

Deletes shopping cart with specified ID.

Shopping cart ID

Returns dataset of all shopping carts for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all shopping carts for specified site.

Site ID

Returns shopping carts that are expired (by default older than 30 days).

Site ID

Returns shopping cart of the specified user.

ID of the user who is the owner of the shopping cart Name of the site to which the shopping cart belongs

Returns ShoppingCartInfo object created from the order data.

ID of the order from which the shopping cart should be created

Deletes shopping cart with specified GUID.

Shopping cart GUID

Deletes shopping cart of the specified user.

ID of the user who is the owner of the shopping cart Name of the site to which the shopping cart belongs

Deletes all items of the specified shopping cart.

Shopping cart ID

Clears customer's private data from shopping cart object.

Shopping cart object

Removes all items from specified shopping cart object.

Shopping cart object

Creates or updates order based on the data of the specified shopping cart.

Shopping cart data

Creates or updates order based on the data of the specified shopping cart.

Shopping cart data Indicates if new invoice should be generated from the new order data. It is True by default.

Creates or updates order items based on the items of the specified shopping cart.

Shopping cart data

Checks shopping cart items. The following conditions must be met to pass the check: 1)All shopping cart items are enabled 2)Max units in one order are not exceeded 3)There is enough units in the inventory 4) Customer is registered, if there is a membership type product in the cart 5)Product validity is valid, if there is a membership or e-product type product in the cart

Shopping cart to check

Returns new empty shopping cart object.

Site ID

Returns new empty shopping cart object created from the given data row.

Data row with shopping cart data

Returns new empty shopping cart object created from deserialized input data.

Data for deserialization from which the shopping cart object should be created Streaming context

Recalculates the whole shopping cart (discounts and taxes of all shopping cart items, content table, content taxes table, shipping and shipping taxes table).

Shopping cart

Recalculates discounts and taxes of all shoppping cart items.

Shopping cart

Recalculates shopping cart content table.

Shopping cart

Recalculates content taxes table (table with summary of all taxes which were applied to the shopping cart items).

Shopping cart

Recalculates shipping taxes table (table with summary of all taxes which were applied to the selected shipping option).

Shopping cart

Creates an empty shopping cart content table.

Filters shopping cart content table.

Shopping cart content table

Creates one row of the content table with the data which are retrieved from the specified shopping cart item.

Shopping cart item Table from which the content row is created

Creates an empty content taxes table.

Creates one row of the content taxes table with the data which are retrieved from the specified shopping cart item tax.

Shopping cart item Table from which the tax row is created Shopping cart item tax which is used for initialization of the tax row

Appends or updates taxes records in table specified by contentTaxesTable parameter according to given item taxes.

Item which tax classes are to be included to contentTaxesTable Shopping cart content taxes table

Updates tax record specified by contentTaxRow parameter according to given item tax.

Content tax row to be be updated. Item tax row used as source of data.

Creates an empty table where taxes summary of the selected shipping option will be stored.

Creates one row of the shipping taxes table with the data which are retrieved from the specified shipping option tax.

Shopping cart Table from which the tax row is created Shipping tax which is used for initialization of the tax row

Calculates total price of the shoppping cart. All discounts, taxes and shipping are included.

Shopping cart

Calculates total price of all shoppping cart items in main currency. Discounts and taxes of the shopping cart items are included.

Shopping cart

Calculates total weight of all shoppping cart items.

Shopping cart

Calculates discount which should be applied to the total items price.

Shopping cart

Calculates total tax which is applied to all shopping cart items altogether. Result is in site main currency.

Shopping cart

Adds product (and its product options) to the specified shopping cart object. If such product configuration already exists in the shopping cart, only its quantity is updated. Added/updated shopping cart item is returned.

Shopping cart Parameters of the shopping cart item which should be used to perform the adding or updating.

Check new shopping cart items (product-site binding, product option - product binding and needed product options. Returns true on success.

Shopping cart object to check SKUs for. Parameters of the shopping cart item which should be used to perform the check.

Returns shopping cart item from the specified shopping cart object.

Shopping cart Shopping cart item ID

Returns shopping cart item from the specified shopping cart object.

Shopping cart Shopping cart item GUID

Removes shopping cart item and its product options from the specified shopping cart object.

Shopping cart Shopping cart item ID

Removes shopping cart item and its product options from the specified shopping cart object.

Shopping cart Shopping cart item GUID

Removes shopping cart item, related bundle items and its product options from the specified shopping cart object.

Shopping cart Shopping cart item

Adds new initialized item to the shopping cart items collection.

Shopping cart Shopping cart item

Returns true, if there is at least one product of the specified type in the shopping cart.

Shopping cart Product type to search for

Returns sum of all shopping cart items' units, bundle items and product options are not included.

Shopping cart data

Returns initialized shopping cart resolver.

Shopping cart data

Returns initialized shopping cart resolver.

Shopping cart data to be used for resolver initialization If true, special macros are added to the resolver (due to the backward compatibility).

Returns the HTML code for the order invoice.

Shopping cart data used for generating invoice

Returns dataset of all shopping carts matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns shopping cart with specified ID.

Shopping cart ID

Returns shopping cart with specified GUID.

Shopping cart GUID

Sets (updates or inserts) specified shopping cart.

Shopping cart to be set

Deletes specified shopping cart.

Shopping cart to be deleted

Returns dataset of all shopping carts for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns shopping carts that are expired (by default older than 30 days).

Site ID

Returns shopping cart of the specified user.

ID of the user who is the owner of the shopping cart Name of the site to which the shopping cart belongs

Returns ShoppingCartInfo object created from the order data.

ID of the order from which the shopping cart should be created

Deletes items of the specified shopping cart.

Shopping cart ID

Clears customer's private data from shopping cart.

Shopping cart object

Removes all items from specified shopping cart object and from the shopping cart in database.

Shopping cart object

Creates or updates order based on the data of the specified shopping cart.

Shopping cart data Indicates if new invoice should be generated from the new order data. It is True by default.

Creates or updates order items based on the items of the specified shopping cart.

Shopping cart data

Checks shopping cart items. The following conditions must be met to pass the check: 1)All shopping cart items are enabled 2)Max units in one order are not exceeded 3)There is enough units in the inventory 4) Customer is registered, if there is a membership type product in the cart 5)Product validity is valid, if there is a membership or e-product type product in the cart

Shopping cart to check

Returns new empty shopping cart object.

Site ID

Returns new empty shopping cart object created from the given data row.

Data row with shopping cart data

Returns new empty shopping cart object created from deserialized input data.

Data for deserialization from which the shopping cart object should be created Streaming context

Recalculates the whole shopping cart (discounts and taxes of all shopping cart items, content table, content taxes table, shipping and shipping taxes table).

Shopping cart

Recalculates discounts and taxes of all shoppping cart items.

Shopping cart

Recalculates shopping cart content table.

Shopping cart

Recalculates content taxes table (table with summary of all taxes which were applied to the shopping cart items).

Shopping cart

Recalculates shipping taxes table (table with summary of all taxes which were applied to the selected shipping option).

Shopping cart

Creates an empty shopping cart content table.

Filters shopping cart content table.

Shopping cart content table

Creates one row of the content table with the data which are retrieved from the specified shopping cart item.

Shopping cart item Table from which the content row is created

Creates an empty content taxes table.

Creates one row of the content taxes table with the data which are retrieved from the specified shopping cart item tax.

Shopping cart item Table from which the tax row is created Shopping cart item tax which is used for initialization of the tax row

Appends or updates taxes records in table specified by contentTaxesTable parameter according to given item taxes.

Item which tax classes are to be included to content taxes table Shopping cart content taxes table

Updates tax record specified by contentTaxRow parameter according to given item tax.

Content tax row to be be updated. Item tax row used as source of data.

Returns row with speciffied tax class ID from given taxes table. Null is returned when tax not found.

Table with shopping cart content taxes ID of the tax class to look for

Creates an empty shipping taxes table (table where taxes summary of the selected shipping option will be stored).

Creates one row of the shipping taxes table with the data which are retrieved from the specified shipping option tax.

Shopping cart Table from which the tax row is created Shipping tax which is used for initialization of the tax row

Calculates single tax which is applied to shipping option. Result is in site main currency.

Shopping cart Table with taxes which were already calculated Data of the tax which is used for tax calculation

Calculates total price of the shoppping cart. All discounts, taxes and shipping are included.

Shopping cart

Calculates total price of all shoppping cart items in main currency. Discounts and taxes of the shopping cart items are included.

Shopping cart

Calculates total weight of all shoppping cart items.

Shopping cart

Calculates discount which should be applied to the total items price.

Shopping cart

Calculates total tax which is applied to all shopping cart items altogether. Result is in site main currency.

Shopping cart

Adds product (and its product options) to the specified shopping cart object. If such product configuration already exists in the shopping cart, only its quantity is updated. Added/updated shopping cart item is returned.

Shopping cart Parameters of the shopping cart item which should be used to perform the adding or updating.

Check new shopping cart items (product-site binding, product option - product binding and needed product options. Returns true on success.

Shopping cart object to check SKUs for. Parameters of the shopping cart item which should be used to perform the check.

Returns shopping cart item from the specified shopping cart object.

Shopping cart Shopping cart item ID

Returns shopping cart item from the specified shopping cart object.

Shopping cart Shopping cart item GUID

Removes shopping cart item, related bundle items and its product options from the specified shopping cart object.

Shopping cart Shopping cart item

Adds new initialized item to the shopping cart items collection.

Shopping cart Shopping cart item

Adds new item to the shopping cart object and returns its object.

Shopping cart Parameters from which the new shopping cart item is initialized.

Updates shopping cart item in the specified shopping cart object. By default only units of the specified shopping cart item and units of its product options are updated.

Shopping cart item to be updated. Parameters of the shopping cart item which should be used to perform the update. By default only Quantity parameter is used.

Returns specified shopping cart item from the given shopping cart object. If such item is not found, null is returned. By default shopping cart item is searched according to the product SKUID and SKUIDs of its product options.

Shopping cart Parameters of the shopping cart item which should be used to perform the search.

Returns true, if there is at least one product of the specified type in the shopping cart.

Shopping cart Product type to search for

Returns sum of all shopping cart items' units, bundle items and product options are not included.

Shopping cart data

Returns initialized shopping cart resolver

Shopping cart data to be used for resolver initialization If true, special macros are added to the resolver (due to the backward compatibility).

Returns the HTML code for the order invoice.

Shopping cart data used for generating invoice

Ensures that shopping cart contains valid data

Returns True, if the given info object is null and the given ID is equal or greater than zero, otherwise returns False.

Info object to check Value of the info object ID column

Gets the data for the shopping cart resolver. (selector -> data object) of the shopping cart objects

Shopping cart from which the data are loaded

Gets the array of old macros, couples (macro, replacement) for the shopping cart resolver (Due to the backward compatibility).

Shopping cart item data container class.

Type information.

Constructor - Creates an empty ShoppingCartItemInfo object.

Constructor - Creates a new ShoppingCartItemInfo object from the given DataRow.

Constructor - Creates a new ShoppingCartItemInfo object from serialized data.

Gets object data.

Invalidates all calculations of the shopping cart item.

Invalidates calculated discounts, taxes and prices.

True - Both shopping cart item table with calculated discounts and all discounts totals are cleared. True - Both shopping cart item table with calculated taxes and all taxes totals are cleared. True - Only shopping cart item discounts totals are cleared. True - Only shopping cart item taxes totals are cleared.

Returns price in shopping cart currency.

Price in site main currency to which the exchange rate should be applied

Returns price in shopping cart currency.

Price to which the shopping cart exchange rate should be applied True - shopping cart exchange rate for global items is used, False - shopping cart exchange rate for site items is used

Returns price in main currency of the site to which the shopping cart belongs.

Price in global main currency to which the exchange rate should be applied

Registers the properties of this object

Data of the shopping cart to which the shopping cart item belongs.

Data of the SKU (product) which is represented by the shopping cart item.

Shopping cart item ID.

Shopping cart item unique identifier. Shopping cart item means collection of the product and its selected product options.

Unique identifier of the parent shopping cart item. When set current SKU is a product option, otherwise it is a product.

Unique identifier of parent shopping cart item. If set, this shopping cart item is a bundle item.

Shopping cart item custom data.

Shopping cart ID.

SKU ID.

Amount of the current shopping cart item in the shopping cart.

If set, its value is used instead of the SKUPrice value in price calculation process. It is set only when cart item represents donation. Then it is amount of donation.

It is set only when cart item represents donation. Then it indicates if the donation is private.

It is set only when cart item represents e-product and when the cart item was loaded from the existing e-product order item. Then it is date and time until the e-product download links are valid.

It is set only when cart item represents text product option. Then it is the text defined by the customer, e.g. custom label for a T-shirt.

Order item data. Loaded when the shopping cart is created from an existing order, otherwise it is null.

List of discounts which should be applied to the shopping cart item.

List of taxes which should be applied to the shopping cart item.

Table with calculated discounts which are applied to the shopping cart item. All table values are in site main currency.

Table with calculated taxes which are applied to the shopping cart item. All table values are in site main currency.

Unit price of the shopping cart item in shopping cart currency.

Unit price of the shopping cart item in site main currency.

Unit price after discount of the shopping cart item in shopping cart currency.

Unit price after discount of the shopping cart item in site main currency.

Unit total price of the shopping cart item in shopping cart currency.

Unit total price of the shopping cart item in site main currency.

Unit discount of the shopping cart item in shopping cart currency.

Unit discount of the shopping cart item in site main currency.

Unit tax of the shopping cart item in shopping cart currency.

Unit tax of the shopping cart item in site main currency.

Total price of the shopping cart item in shopping cart currency.

Total price of the shopping cart item in site main currency.

Total discount in shopping cart currency which is applied to the shopping cart item.

Total discount in site main currency which is applied to the shopping cart item.

Total tax in shopping cart currency which is applied to the shopping cart item.

Total tax in site main currency which is applied to the shopping cart item.

Unit weight of the shopping cart item.

Total weight of the shopping cart item.

Data of the shopping cart to which the shopping cart item belongs.

Data of the SKU (product) which is represented by the shopping cart item.

List with product options of the shopping cart item.

Indicates if shopping cart item is representing product or product option.

List of bundle items of the shopping cart item.

Indicates if shopping cart item is representing bundle item.

Shopping cart item which represents product in which the current product option is included. If the current item is not product option, returns null.

Shopping cart item which represents bundle product in which the current bundle item is included. If the current item is not bundle item, returns null.

Determines whether there is a discount which is not applied to all units of the shopping cart item

Class providing ShoppingCartItemInfo management.

Returns dataset of all shopping cart items matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all shopping cart items matching the specified parameters.

Where condition Order by expression

Returns shopping cart item with specified ID.

Shopping cart item ID

Returns shopping cart item with specified GUID.

Shopping cart item GUID

Sets (updates or inserts) specified shopping cart item.

Shopping cart item to be set

Deletes specified shopping cart item.

Shopping cart item to be deleted

Deletes shopping cart item with specified ID.

Shopping cart item ID

Deletes shopping cart item with specified GUID.

Shopping cart item GUID

Returns shoppping cart item created from the order item data.

Order item Current data of the product (SKU) which is associated with the order item

Returns DataSet with all shopping cart items data of the specified cart. DataSet includes both SKU data and shopping cart item data.

Shopping cart ID

Returns DataSet with all shopping cart items of the specified order. DataSet includes both SKU data and order item data.

Order ID

Loads shopping cart items into the specified shopping cart. If shopping cart is created from an order, cart items are loaded from the corresponding order items.

Shopping cart

Indicates if specified shopping cart item is representing product with at least one text option.

Shopping cart item to check.

Checks shopping cart item in the shopping cart. The following conditions must be met to pass the check: 1)Shopping cart item is enabled 2)Max units in one order are not exceeded 3)There is enough units in the inventory 4) Customer is registered, if it is a membership type product 5)Product validity is valid, if it is a membership or e-product type product

Shopping cart item to check

Returns sum of all units of the specified SKU in the order from which the shopping cart item is loaded.

Shopping cart item which is loaded from the order (has order data).

Returns sum of all units of the specified SKU in the shopping cart to which the shopping cart item belongs.

Shopping cart item.

Returns initialized shopping item cart resolver.

Shopping cart item data to be used for resolver initialization

Calculates shopping cart item discounts and taxes.

Shopping cart item

Calculates shopping cart item discounts.

Shopping cart item

Calculates shopping cart item taxes.

Shopping cart item

Creates empty table for calculated shopping cart item discounts.

Creates empty table for calculated shopping cart item taxes.

Creates one row of the discounts table with the data which are calculated from the shopping cart item and specified discount.

Shopping cart item Discount which should be applied to the shopping cart item

Creates one row of the taxes table with the data which are calculated from the shopping cart item and specified tax.

Shopping cart item Tax which should be applied to the shopping cart item

Returns list of all discounts which should be applied to the specified shopping cart item.

Shopping cart item

Calculates single discount which is applied to one shopping cart item unit. Result is in site main currency.

Shopping cart item Discount which should be applied to the shopping cart item

Calculates single tax which is applied to one shopping cart item unit. Result is in site main currency.

Shopping cart item Data of the tax which is used for unit tax calculation

Calculates the subtotal of a single discount which is applied to all shopping cart item units altogether. Result is in site main currency.

Shopping cart item Data of the discount which was used for unit discount calculation Calculated unit discount

Calculates the subtotal of a single tax which is applied to all shopping cart item units altogether. Result is in site main currency.

Shopping cart item Data of the tax which was used for unit tax calculation Calculated unit tax

Calculates the sum of all discounts which are applied to one shopping cart item unit altogether. Result is in site main currency.

Shopping cart item

Calculates the sum of all taxes which are applied to one shopping cart item unit altogether. Result is in site main currency.

Shopping cart item

Calculates the sum of all discounts which are applied to all shopping cart item units altogether. Result is in site main currency.

Shopping cart item

Calculates the sum of all taxes which are applied to all shopping cart item units altogether. Result is in site main currency.

Shopping cart item

Calculates the price of one shopping cart item unit. Result is in site main currency.

Shopping cart item

Calculates the total price of one shopping cart item unit. Shopping cart item unit total discount and unit total tax are included. Result is in site main currency.

Shopping cart item

Calculates the total price of all shopping cart item units altogether. Shopping cart item total discount and total tax are included. Result is in site main currency.

Shopping cart item

Calculates the weight of one shopping cart item unit. 'SKUWeight' field value of the corresponding SKU is returned by default.

Shopping cart item

Calculates the total weight of all shopping cart item units altogether.

Shopping cart item

Returns unit price after the discounts which were already applied. Result is in site main currency.

Shopping cart item

Returns dataset of all shopping cart items matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns shopping cart item with specified ID.

Shopping cart item ID

Returns shopping cart item with specified GUID.

Shopping cart item GUID

Sets (updates or inserts) specified shopping cart item.

Shopping cart item to be set

Deletes specified shopping cart item.

Shopping cart item to be deleted

Returns shoppping cart item created from the order item data.

Order item Current data of the product (SKU) which is associated with the order item

Returns DataSet with all shopping cart items data of the specified cart. DataSet includes both SKU data and shopping cart item data.

Shopping cart ID

Returns DataSet with all shopping cart items of the specified order. DataSet includes both SKU data and order item data.

Order ID

Loads shopping cart items into the specified shopping cart. Shopping cart items are loaded from standard shopping cart items data.

Shopping cart

Loads shopping cart items into the specified shopping cart. Shopping cart items are loaded from items of the order from which the shopping cart is created.

Shopping cart which is created from order data

Indicates if specified shopping cart item is representing product with at least one text option.

Shopping cart item to check.

Checks shopping cart item in the shopping cart. If check fails the specified error message is returned, otherwise an empty string is returned. The following conditions must be met to pass the check: 1)Shopping cart item is enabled 2)Max units in one order are not exceeded 3)There is enough units in the inventory 4) Customer is registered, if it is a membership type product 5)Product validity is valid, if it is a membership or e-product type product

Shopping cart item to check

Returns sum of all units of the specified SKU in the order from which the shopping cart item is loaded.

Shopping cart item which is loaded from the order (has order data).

Returns sum of all units of the specified SKU in the shopping cart to which the shopping cart item belongs.

Shopping cart item.

Returns initialized shopping item cart resolver.

Shopping cart item data to be used for resolver initialization

Calculates shopping cart item discounts and taxes.

Shopping cart item

Calculates shopping cart item discounts.

Shopping cart item

Calculates shopping cart item taxes.

Shopping cart item

Creates empty table for calculated shopping cart item discounts.

Creates empty table for calculated shopping cart item taxes.

Creates one row of the discounts table with the data which are calculated from the shopping cart item and specified discount.

Shopping cart item Discount which should be applied to the shopping cart item

Creates one row of the taxes table with the data which are calculated from the shopping cart item and specified tax.

Shopping cart item Tax which should be applied to the shopping cart item

Returns the list of all discounts which should be applied to the specified shopping cart item.

Shopping cart item

Calculates single discount which is applied to one shopping cart item unit. Result is in site main currency.

Shopping cart item Discount which should be applied to the shopping cart item

Calculates average discount per shopping cart item unit. If discount is applied to all units of the shopping cart item average discount is equal to unit discount. Result is in site main currency.

Shopping cart item Discount which should be applied to the shopping cart item Calculated subtotal discount

Calculates single tax which is applied to one shopping cart item unit. Result is in site main currency.

Shopping cart item Data of the tax which is used for unit tax calculation

Calculates the subtotal of a single discount which is applied to all shopping cart item units altogether. Result is in site main currency.

Shopping cart item Data of the discount which was used for unit discount calculation Calculated unit discount

Calculates the subtotal of a single tax which is applied to all shopping cart item units altogether. Result is in site main currency.

Shopping cart item Data of the tax which was used for unit tax calculation Calculated unit tax

Calculates the sum of all discounts which are applied to one shopping cart item unit altogether. Result is in site main currency.

Shopping cart item

Calculates the sum of all taxes which are applied to one shopping cart item unit altogether. Result is in site main currency.

Shopping cart item

Calculates the sum of all discounts which are applied to all shopping cart item units altogether. Result is in site main currency.

Shopping cart item

Calculates the sum of all taxes which are applied to all shopping cart item units altogether. Result is in site main currency.

Shopping cart item

Calculates the price of one shopping cart item unit. Result is in site main currency.

Shopping cart item

Calculates the total price of one shopping cart item unit. Shopping cart item unit total discount and unit total tax are included. Result is in site main currency.

Shopping cart item

Calculates the total price of all shopping cart item units altogether. Shopping cart item total discount and total tax are included. Result is in site main currency.

Shopping cart item

Calculates the weight of one shopping cart item unit. 'SKUWeight' field value of the corresponding SKU is returned by default.

Shopping cart item

Calculates the total weight of all shopping cart item units altogether.

Shopping cart item

Returns unit price after the discounts which were already applied. Result is in site main currency.

Shopping cart item

Round double value according shoppingcart item RoundTo property.

Value to round Shopping cart item Rounded value

Sets product options of each parent cart item and puts all cart items to the proper order (parent1-parent1 children, parent2- parent2 children,...).

List of shopping cart item objects

Says how the customer is represented during shopping.

Customer will use existing account for registration.

Customer will create new account.

Customer will continue as anonymous.

SKUDiscountCouponInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty SKUDiscountCouponInfo object.

Constructor - Creates a new SKUDiscountCouponInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

ID of the SKU.

ID of the coupon.

Class providing SKUDiscountCouponInfo management.

Returns dataset of all relationships between SKUs and discount coupons matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all relationships between SKUs and discount coupons matching the specified criteria.

Where condition Order by expression

Returns relationship between specified SKU and discount coupon.

SKU ID Discount coupon ID

Sets relationship between specified SKU and discount coupon.

SKU-discount coupon relationship to be set

Deletes relationship between specified SKU and discount coupon.

SKU-discount coupon relationship to be deleted

Sets relationship between specified SKU and discount coupon.

SKU ID Discount coupon ID

Deletes relationship between specified SKU and discount coupon.

SKU ID Discount coupon ID

Returns true if discount coupon can be applied to the given SKU.

SKU Discount coupon

Returns dataset of all relationships between SKUs and discount coupons matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns relationship between specified SKU and discount coupon.

SKU ID Discount coupon ID

Sets relationship between specified SKU and discount coupon.

SKU-discount coupon relationship to be set

Deletes relationship between specified SKU and discount coupon.

SKU-discount coupon relationship to be deleted

Returns true if discount coupon can be applied to the given SKU.

SKU Discount coupon

SKUInfo data container class.

Type information SKU.

Type information Option SKU.

SKU custom data.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Gets the resource key for the name of the object type.

This method is called once the object is completely cloned (with all children, bindings, etc.). Performs additional

Cloning settings Result of the cloning - messages in this object will be altered by processing this method Original source BaseInfo (object being cloned)

Constructor for deserialization.

Serialization inf Streaming context

Constructor - Creates an empty SKUInfo object.

Constructor - Creates a new SKUInfo object from the given DataRow.

Source data row

Constructor - Creates a new SKUInfo object from the given DataContainer.

Source data

Gets object data.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Type info.

Product internal status ID.

Product department ID.

Product manufacturer ID.

Product description.

Short product description.

Product name.

Product ID.

Product number.

Product enabled.

Product available in days.

Product public status ID.

Product supplier ID.

Product price.

Product retail price.

Product GUID.

SKU site ID. Set to 0 for global SKU.

Product image path.

Product weight.

Product height.

Product width.

Product depth.

Product available items.

Available items quantity at which the product is to be reordered.

Product sell only available.

Product custom data.

SKU option category ID.

SKU option order within the parent option category.

Object last modified.

Object creation date.

Indicates if current SKU is representing product or product option.

Product type.

Conversion name of the product

Conversion value of the product

GUID of the membership associated with SKU.

Validity type of SKU.

Multiplier for period defined by SKU validity type.

Date until which products represented by SKU are valid.

Maximum number of downloads.

Indicates how bundle product is removed from inventory.

Indicates if donation represented by SKU is allowed to be private.

Minimum allowed price of SKU.

Maximum allowed price of SKU.

Indicates if SKU needs to be shipped.

Minimum number of units of SKU allowed to be in one order.

Maximum number of units of SKU allowed to be in one order.

Date from which the SKU is available in store

Class providing SKUInfo management.

Status of the e-commerce license for domains

Constructor.

Returns dataset of all products and product options matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all products and product options matching the specified parameters.

Where condition Order by expression

Returns product with specified ID.

Product ID

Returns product with specified GUID.

Product GUID

Sets (updates or inserts) specified product.

Product to be set

Deletes specified product.

Product to be deleted

Deletes product with specified ID.

Product ID

Clears hashtables.

If true, web farm tasks are logged

Returns SKU data for the specified shopping cart item.

Shopping cart item. Current SKU data loaded from the products catalog. Old SKU data loaded from the associated order item.

Returns dataset of all products and product options for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all products and/or product options for specified site matching the specified parameters.

Site ID Indicates if products should be selected Indicates if product options should be selected Where condition Order by expression

Returns dataset of all products including display names of product statuses. This method is used to display list of products in the user interface.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all products including display names of product statuses. This method is used to display list of products in the user interface.

Query parameters Where condition to filter products Order by statement Specifies number of returned products Data columns to return If true, binary data are returned in the result Index of first record to get Maximum number of products to get. If maxRecords is zero or less, all products are returned (no paging is used) Returns total number of available products

Returns dataset with products which were bought together with specified product.

Product ID Site ID Where condition

Returns dataset with top N products by sales.

Number of products to be selected Site ID Where condition

Returns dataset of all product options from specified product option category.

Product option category ID Indicates if only enabled product options should be selected

Returns number of product options which are defined for the specified product option category.

Product option category ID

Moves specified product option up within the parent option category.

Product option ID

Moves specified product option down within the parent option category.

Product option ID

Returns dataset of all bundle items for specified bundle SKU ID.

Bundle SKU ID

Returns dataset with the products from specified user's wishlist.

ID of the user the wishlist belongs to Site ID

Returns the dataset of all products which are assigned to the specified discount coupon.

Coupon ID

Returns user friendly URL of the specified product.

Product unique identifier (GUID) Product name Site Name

Returns user friendly URL of the specified product.

Product unique identifier (GUID) Product name

Updates products' available items according to the products' units of the specified shopping cart.

Shopping cart with some products

Indicates if user is authorized to modify specific SKU. For global SKU: 'EcommerceGlobalModify' permission is checked. For site-specific SKU: 'EcommerceModify' OR 'ModifyProducts' permission is checked.

SKU to be checked Site name User to be checked

Indicates if user is authorized to modify SKUs.

For global SKUs (global = True): 'EcommerceGlobalModify' permission is checked. For site-specific SKUs (global = False): 'EcommerceModify' OR 'ModifyProducts' permission is checked. Site name User to be checked

Checks dependencies, returns true if dependent.

Product identifier

License version check.

Domain name Feature Action to check

Recalculates products (including product options) prices using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional WHERE condition Id of the site which records are to be recalculated

Recalculate prices in fields of all product documents which are mapped to SKU price field. This method is invoked in case of changing main currency.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional WHERE condition for View_CMS_Tree_Joined filtering Id of the site which main currency was changed (0 for global main currency changed)

Sorts product options of the specified option category alphabetically (A-Z).

ID of option category

Returns True if there are any enabled options categories with some enabled product options assigned to the specified SKU, otherwise returns False.

SKU ID

Indicates if the given SKU is new in the store. By default it is determined based on the CMSStoreProductsAreNewFor setting and SKUInStoreFrom property.

SKU data

Indicates if the given SKU can be bought by the customer based on the SKU inventory properties.

SKU data

Returns product catalogue price based on the SKU data and shopping cart data. Catalogue discounts and/or taxes are included optionally. Result is in site main currency.

SKU data Shopping cart data True - catalogue discounts are applied to the price True - catalogue taxes are applied to the discounted price

Returns product catalogue price based on the SKU data and shopping cart data. Catalogue discounts and/or taxes are included optionally. Result is in site main currency.

SKU data Shopping cart data True - catalogue discounts are applied to the price True - catalogue taxes are applied to the discounted price True - This method is called within the shopping cart calculations, False (default) - This method is called within the displaying price on the live site.

Returns product catalogue price based on the SKU data and shopping cart data. Catalogue discounts and/or taxes are included optionally. Result is in site main currency.

SKU data Shopping cart data True - catalogue discounts are applied to the price True - catalogue taxes are applied to the discounted price True - This method is called within the shopping cart calculations, False (default) - This method is called within the displaying price on the live site. Name of the column the price should be retrieved from. If empty, SKUPrice column is used.

Returns formatted product catalogue price based on the SKU data and shopping cart data. Catalogue discounts and/or taxes are included optionally. Result is in shopping cart currency.

SKU data Shopping cart data True - catalogue discounts are applied to the price True - catalogue taxes are applied to the discounted price

Returns formatted product catalogue price based on the SKU data and shopping cart data. Catalogue discounts and/or taxes are included optionally. Result is in shopping cart currency.

SKU data Shopping cart data True - catalogue discounts are applied to the price True - catalogue taxes are applied to the discounted price Name of the column the price should be retrieved from. If empty, SKUPrice column is used.

Returns value of the SKU catalogue price based on the SKU data and shopping cart data.

SKU data Shopping cart data

Returns value of the SKU catalogue price based on the SKU data and shopping cart data.

SKU data Shopping cart data Name of the column the price should be retrieved from. If empty, SKUPrice column is used.

Returns dataset of all products and product options matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns product with specified ID.

Product ID

Returns product with specified GUID.

Product GUID

Sets (updates or inserts) specified product.

Product to be set

Deletes specified product.

Product to be deleted

Returns SKU data for the specified shopping cart item.

Shopping cart item. Current SKU data loaded from the products catalog. Old SKU data loaded from the associated order item.

Returns dataset of all products and product options for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all products and/or product options for specified site matching the specified parameters.

Site ID Indicates if products should be selected Indicates if product options should be selected Where condition Order by expression

Returns dataset of all products including display names of product statuses.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all products including display names of product statuses. This method is used to display list of products in the user interface.

Query parameters Where condition to filter products Order by statement Specifies number of returned products Data columns to return If true, binary data are returned in the result Index of first record to get Maximum number of products to get. If maxRecords is zero or less, all products are returned (no paging is used) Returns total number of available products

Returns dataset with products which were bought together with specified product.

Product ID Site ID Where condition

Returns dataset with top N products by sales.

Number of products to be selected Site ID Where condition

Returns dataset of all product options from specified product option category.

Product option category ID Indicates if only enabled product options should be selected

Returns number of product options which are defined for the specified product option category.

Product option category ID

Moves specified product option up within the parent option category.

Product option ID

Moves specified product option down within the parent option category.

Product option ID

Returns dataset of all bundle items for specified bundle SKU ID.

Bundle SKU ID

Returns dataset with the products from specified user's wishlist.

ID of the user the wishlist belongs to Site ID

Returns the dataset of all products which are assigned to the specified discount coupon.

Coupon ID

Returns user friendly URL of the specified product.

Product unique identifier (GUID) Product name Site Name

Updates products' available items in database according to the products' units of the specified shopping cart.

Shopping cart with some products

Recalculates products (including product options) prices using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional WHERE condition ID of the site which records are to be recalculated

Recalculate prices in fields of all product documents which are mapped to SKU price field. This method is invoked in case of changing main currency.

Factor by which values are recalculated Number of significant digits the number should be rounded to Additional WHERE condition for View_CMS_Tree_Joined filtering Id of the site which main currency was changed (0 for global main currency changed)

Sorts product options of the specified option category alphabetically (A-Z).

Option category ID

Returns True if there are any enabled options categories with some enabled product options assigned to the specified SKU, otherwise returns False.

SKU ID

Indicates if the given SKU is new in the store. By default it is determined based on the CMSStoreProductsAreNewFor setting and SKUInStoreFrom property.

SKU data

Indicates if the given SKU can be bought by the customer based on the SKU inventory settings.

SKU data

Returns product catalogue price based on the SKU data and the shopping cart data. Discounts and/or taxes are included optionally. Result is in site main currency.

SKU data Shopping cart data True - catalogue discounts are applied to the price True - catalogue taxes are applied to the discounted price True - This method is called within the shopping cart calculations, False - This method is called within the displaying price on the live site. Name of the column the price should be retrieved from. If empty, SKUPrice column is used.

Returns formatted product catalogue price based on the SKU data and the shopping cart data. Discounts and/or taxes are included optionally. Result is in shopping cart currency.

SKU data Shopping cart data True - catalogue discounts are applied to the price True - catalogue taxes are applied to the discounted price Name of the SKU column the price should be retrieved from. If empty, SKUPrice field is used.

Returns value of the SKU catalogue price based on the SKU data and shopping cart data. By default value from SKUPrice field is returned.

SKU data Shopping cart data

Returns value of the SKU catalogue price based on the SKU data and shopping cart data.

SKU data Shopping cart data Name of the column from which the SKU price should be retrieved. If empty, SKUPrice column is used.

Returns list of catalogue discounts which should be applied to the given product based on the product data and shopping cart data.

SKU data Shopping cart data True - This method is called within the shopping cart calculations, False - This method is called within the displaying price on the live site.

Calculates product price after all its catalogue discounts are applied.

SKU data Shopping cart data True - This method is called within the shopping cart calculations, False - This method is called within the displaying price on the live site. Name of the column from which the product price should be retrieved. If empty, SKUPrice column is used.

Calculates specified catalog discount which should be applied to the given product. Result is in site main currency.

SKU data Shopping cart data Discount data SKU price after previous discounts

Returns product total tax in site main currency based on the product data and the data of the shopping cart. Result is cached according to the content cache settings (CMSCacheMinutes settings key).

SKU data Shopping cart data SKU price in main currency after discount the tax should be applied to

Returns product total tax in site main currency based on the product data and the data of the shopping cart.

SKU data Shopping cart data SKU price in main currency after discount the tax should be applied to

Returns SKUProductType enum.

SKU product type

Returns SKUProductType string.

SKU product type

Returns BundleInventoryType enum.

Bundle inventory type

Returns BundleInventoryType string.

Bundle inventory type

Clear e-commerce license.

Updates search index of depending nodes.

Product data

Sets default tax class to a specified product according to its department.

Product data

Logs synchronization task when product options order was changed.

ID of the moved option.

License limitation for ecommerce products number

SKUOptionCategoryInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty SKUOptionCategoryInfo object.

Constructor - Creates a new SKUOptionCategoryInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Unique identifier of the relationship between SKU and product option category.

ID of the SKU.

ID of the product option category.

Indicates if all product options from the given product option category are allowed for the given SKU. By default it is True.

Class providing SKUOptionCategoryInfo management.

Returns dataset of all relationships between categories and SKUs matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all relationships between categories and SKUs matching the specified criteria.

Where condition Order by expression

Returns specified relationship between the given category and SKU.

Category-SKU relationship ID.

Returns relationship between specified category and SKU.

Category ID SKU ID

Sets relationship between specified category and SKU.

Category-SKU relationship to be set

Deletes relationship between specified category and SKU.

Category-SKU relationship to be deleted

Sets relationship between specified category and SKU.

Category ID SKU ID

Deletes relationship between specified category and SKU.

Category ID SKU ID

Returns dataset of all relationships between categories and SKUs matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns specified relationship between the given category and SKU.

Category-SKU relationship ID.

Returns relationship between specified category and SKU.

Category ID SKU ID

Sets relationship between specified category and SKU.

Category-SKU relationship to be set

Deletes relationship between specified category and SKU.

Category-SKU relationship to be deleted

SKUTaxClassInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty SKUTaxClassInfo object.

Constructor - Creates a new SKUTaxClassInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

ID of the SKU.

ID of the tax class.

Class providing SKUTaxClassInfo management.

Returns dataset of all relationships between SKUs and tax classes matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all relationships between SKUs and tax classes matching the specified criteria.

Where condition Order by expression

Returns relationship between specified SKU and tax class.

Tax class ID SKU ID

Sets relationship between specified SKU and tax class.

SKU-tax class relationship to be set

Deletes relationship between specified SKU and tax class.

SKU-tax class relationship to be deleted

Sets relationship between specified SKU and tax class.

Tax class ID SKU ID

Deletes relationship between specified SKU and tax class.

Tax class ID SKU ID

Returns dataset of all relationships between SKUs and tax classes matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns relationship between specified SKU and tax class.

Tax class ID SKU ID

Sets relationship between specified SKU and tax class.

SKU-tax class relationship to be set

Deletes relationship between specified SKU and tax class.

SKU-tax class relationship to be deleted

SupplierInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty SupplierInfo object.

Constructor - Creates a new SupplierInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Fax of the supplier.

E-mail of the supplier.

ID of the supplier.

Phone of the supplier.

Supplier display name.

Supplier code name.

Supplier enabled.

Supplier GUID.

Object last modified.

Supplier site ID. Set to 0 for global supplier.

Class providing SupplierInfo management.

Constructor.

Returns dataset of all suppliers matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all suppliers matching the specified parameters.

Where condition Order by expression

Returns supplier with specified ID.

Supplier ID

Sets (updates or inserts) specified supplier.

Supplier to be set

Deletes specified supplier.

Supplier to be deleted

Deletes supplier with specified ID.

Supplier ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all suppliers for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all suppliers for specified site.

Site ID True - only enable suppliers are returned. False - both enabled and disabled suppliers are returned.

Returns suppliers with specified code name.

Supplier code name Supplier site name

Checks dependencies, returns true if dependent.

Supplier ID

Indicates if user is authorized to modify specific supplier. For global supplier: 'EcommerceGlobalModify' permission is checked. For site-specific supplier: 'EcommerceModify' OR 'ModifySuppliers' permission is checked.

Supplier to be checked Site name User to be checked

Indicates if user is authorized to modify suppliers.

For global suppliers (global = True): 'EcommerceGlobalModify' permission is checked. For site-specific suppliers (global = False): 'EcommerceModify' OR 'ModifySuppliers' permission is checked. Site name User to be checked

Returns dataset of all suppliers matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns supplier with specified ID.

Supplier ID

Sets (updates or inserts) specified supplier.

Supplier to be set

Deletes specified supplier.

Supplier to be deleted

Returns dataset of all suppliers for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all suppliers for specified site.

Site ID True - only enable suppliers are returned. False - both enabled and disabled suppliers are returned.

Returns suppliers with specified code name.

Supplier code name Supplier site name

TaxClassCountryInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty TaxClassCountryInfo object.

Constructor - Creates a new TaxClassCountryInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Tax class - country relationship ID.

Value of the tax.

ID of the country.

ID of the tax class.

Indicates whether the value is flat or not.

Class providing TaxClassCountryInfo management.

Returns dataset of all relationships between tax classes and countries matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all relationships between tax classes and countries matching the specified criteria.

Where condition Order by expression

Returns relationship between specified tax class and country.

Country ID Tax class ID

Sets relationship between specified tax class and country.

Tax class-country relationship to be set

Deletes relationship between specified tax class and country.

Tax class-country relationship to be deleted

Removes tax value defined for specified country.

Country ID Tax class ID

Returns dataset with countries and their values of the specified tax. This method is used in the administration user inteface when configuring values of the specified tax for all contries.

Tax class ID

Copies country-specific tax values from global another country.

ID of the tax class used as source ID of the tax class used as destination

Recalculates country-dependent value of tax class using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Indicates if flat values should be recalculated Indicates if relative values should be recalculated Additional WHERE condition ID of the site which records are to be recalculated

Returns dataset of all relationships between tax classes and countries matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns relationship between specified tax class and country.

Country ID Tax class ID

Sets relationship between specified tax class and country.

Tax class-country relationship to be set

Deletes relationship between specified tax class and country.

Tax class-country relationship to be deleted

Returns dataset with countries and their values of the specified tax. This method is used in the administration user inteface when configuring values of the specified tax for all contries.

Tax class ID

Recalculates country-dependent value of tax class using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Indicates if flat values should be recalculated Indicates if relative values should be recalculated Additional WHERE condition ID of the site which records are to be recalculated

Copies country-specific tax values from global another country.

ID of the tax class used as source ID of the tax class used as destination

TaxClassInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Inserts cloned object to DB.

Cloning settings Cloning result Original source BaseInfo (object being cloned)

Fills data properties with values from given template.

Template to copy data from

Constructor - Creates an empty TaxClassInfo object.

Constructor - Creates a new TaxClassInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Display name of the tax class.

ID of the tax class.

Code name of the tax class.

Zero tax if tax ID is supplied.

TaxClass GUID.

Object last modified.

Tax class site ID. Set to 0 for global tax class.

Class providing TaxClassInfo management.

Constructor.

Returns dataset of all tax classes matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all tax classes matching the specified parameters.

Where condition Order by expression

Returns tax class with specified ID.

Tax class ID

Returns tax class with specified name.

Tax class name Site name

Sets (updates or inserts) specified tax class.

Tax class to be set

Deletes specified tax class.

Tax class to be deleted

Deletes tax class with specified ID.

Tax class ID

Clears hashtables.

If true, web farm tasks are logged

Returns dataset of all tax classes for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns dataset of all tax classes for specified site.

Site ID

Returns DataSet with all the tax classes that are assigned to the specified product.

SKU ID

Returns DataSet with all the tax classes that are assigned to the specified department.

Department ID

Returns DataSet with all the taxes that are applied to the specified product and their values according to the specified country, state and zip code.

SKU ID State ID Country ID ZIP code - for later use, not implemented yet.

Returns the modified price after the specified tax is applied.

Price the tax should be applied to Tax value, either flat or relative True - tax value is flat, False - tax value is relative

Returns calculated tax based on the product price and tax type.

Price the tax should be calculated from Tax value True - tax value is flat (both price and tax value must be expressed in the same currency to obtain correct result), False - tax value is relative (currency of the price is not important).

Copies site-specific tax class options from global tax class list.

Id of the site for which new tax classes are to be created

Checks tax class dependencies. Returns true if the tax class is dependent.

Tax class ID

Recalculates tax class values (values for countries and states) using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Indicates if flat values should be recalculated Indicates if relative values should be recalculated Additional WHERE condition ID of the site which records are to be recalculated

Returns DataSet with all taxes which should be applied the shopping cart items.

Shopping cart

Returns DataSet with all taxes which should be applied to the shopping cart shipping option.

Shopping cart

Returns list of all taxes which should be applied to the specified shopping cart item.

Shopping cart item

Returns dataset of all tax classes matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns tax class with specified ID.

Tax class ID

Returns tax class with specified name.

Tax class name Site name

Sets (updates or inserts) specified tax class.

Tax class to be set

Deletes specified tax class.

Tax class to be deleted

Returns dataset of all tax classes for specified site matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected Site ID

Returns DataSet with all the taxes that are assigned to the specified product.

SKU ID

Returns DataSet with all the taxes that are assigned to the specified department.

Department ID

Returns DataSet with all the taxes that are applied to the specified product and their values according to the specified country, state and zip code.

SKU ID State ID Country ID ZIP code - for later use, not implemented yet.

Returns tax value based on the product price and tax type.

Price the tax should be calculated from Tax value True - tax value is flat, False - tax value is relative

Returns the modified price after the specified tax is applied.

Price the tax should be applied to Tax value, either flat or relative True - tax value is flat, False - tax value is relative

Copies site-specific tax class options from global tax class list.

Id of the site for which new tax classes are to be created

Recalculates tax class values (values for countries and states) using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Indicates if flat values should be recalculated Indicates if relative values should be recalculated Additional WHERE condition ID of the site which records are to be recalculated

Returns DataSet with all taxes which should be applied the shopping cart items.

Shopping cart

Returns DataSet with all taxes which should be applied to the shopping cart shipping option.

Shopping cart

Returns list of all taxes which should be applied to the specified shopping cart item.

Shopping cart item

Returns ITaxClassInfo object created from the given data row.

Data row with the tax calculated data. Names of data row columns: TaxClassID, TaxClassDisplayName, TaxClassZeroIfIDSupplied, TaxValue, TaxIsFlat, TaxIsGlobal

Attempts to delete the tax class. Has no effect, if tax class is used.

Tax to be deleted

TaxClassStateInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty TaxClassStateInfo object.

Constructor - Creates a new TaxClassStateInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Tax class - state relationship ID.

Value of the tax.

ID of the tax class.

Indicates whether the value is flat or not.

ID of the state.

Class providing TaxClassStateInfo management.

Returns dataset of all relationships between tax classes and states matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all relationships between tax classes and states matching the specified criteria.

Where condition Order by expression

Returns relationship between specified tax class and state.

Tax class ID State ID

Sets relationship between specified tax class and state.

Tax class-state relationship to be set

Deletes relationship between specified tax class and state.

Tax class-state relationship to be deleted

Removes tax value defined for specified state.

Tax class ID State ID

Recalculates state-dependent value of tax class using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Indicates if flat values should be recalculated Indicates if relative values should be recalculated Additional WHERE condition ID of the site which records are to be recalculated

Returns dataset with states and their values of the specified tax. This method is used in the administration user inteface when configuring values of the specified tax for all states.

Tax class ID Country ID

Copies state-specific tax values from another tax class.

Id of the tax class used as source Id of the tax class used as destination

Copies state-specific tax values from another country.

Id of the tax class used as source Id of the tax class used as destination Id of the country which states should be copied

Returns dataset of all relationships between tax classes and states matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns relationship between specified tax class and state.

Tax class ID State ID

Sets relationship between specified tax class and state.

Tax class-state relationship to be set

Deletes relationship between specified tax class and state.

Tax class-state relationship to be deleted

Recalculates state-dependent value of tax class using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Indicates if flat values should be recalculated Indicates if relative values should be recalculated Additional WHERE condition ID of the site which records are to be recalculated

Returns dataset with states and their values of the specified tax. This method is used in the administration user inteface when configuring values of the specified tax for all states.

Tax class ID Country ID

Copies state-specific tax values from another tax class.

Id of the tax class used as source Id of the tax class used as destination

Copies state-specific tax values from another country.

Id of the tax class used as source Id of the tax class used as destination Id of the country which states should be copied

UserDepartmentInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor - Creates an empty UserDepartmentInfo object.

Constructor - Creates a new UserDepartmentInfo object from the given DataRow.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

ID of the user.

ID of the department.

Class providing UserDepartmentInfo management.

Returns dataset of all relationships between users and departments matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all relationships between users and departments matching the specified criteria.

Where condition Order by expression

Returns relationship between specified user and department.

User ID Department ID

Sets relationship between specified user and department.

User-department relationship to be set

Deletes relationship between specified user and department.

User-department relationship to be deleted

Sets relationship between specified user and department.

Department ID User ID

Deletes relationship between specified user and department.

Department ID User ID

Returns dataset of all relationships between users and departments matching the specified criteria.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns relationship between specified user and department.

Department ID User ID

Sets relationship between specified user and department.

User-department relationship to be set

Deletes relationship between specified user and department.

User-department relationship to be deleted

VolumeDiscountInfo data container class.

Type information.

Deletes the object using appropriate provider.

Updates the object using appropriate provider.

Constructor for deserialization.

Serialization info Streaming context

Constructor - Creates an empty VolumeDiscountInfo object.

Constructor - Creates a new VolumeDiscountInfo object from the given DataRow.

Gets object data.

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

ID of the discount.

Value of the discount.

Minimal number of objects for the discount to be applied.

ID of the SKU for which the discount is applied.

Indicates whether the discount is flat or not.

GUID of the discount.

Object last modified.

Discount type. Used for discount calculation in the shopping cart.

Discount identifier. Used for discount calculation in the shopping cart.

Discount display name. Used for discount calculation in the shopping cart.

Discount value. Used for discount calculation in the shopping cart.

True - discount value is flat, False - discount value is relative. Used for discount calculation in the shopping cart.

True - says that discounts value is set in global main currency, False - says that discounts value is set in site main currency. Takes effect only if discount value is flat. Used for discount calculation in the shopping cart.

Number of units the discount should be applied to

Discount custom data.

Class providing VolumeDiscountInfo management.

Constructor.

Returns dataset of all volume discounts matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns dataset of all volume discounts matching the specified parameters.

Where condition Order by expression

Returns volume discount with specified ID.

Volume discount ID

Sets (updates or inserts) specified volume discount.

Volume discount to be set

Deletes specified volume discount.

Volume discount to be deleted

Deletes volume discount with specified ID.

Volume discount ID

Clears hashtables.

If true, web farm tasks are logged

Returns DataSet with volume discounts for specified product(SKU).

SKU id

Returns coresponding VolumeDiscountInfo structure for the specified SKU and SKU units, if no volume discount found returns null.

SKU id SKU units

Recalculates volume discount values using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Indicates if flat values should be recalculated Indicates if relative values should be recalculated Additional WHERE condition ID of the site which records are to be recalculated

Returns True if volume discount is valid and can be applied to the specified shopping cart item, otherwise returns False.

Shopping cart item to which the volume discount should be applied Volume discount data

Validates volume discount and calculates shopping cart item unit discount after the volume discount is applied.

Shopping cart item to which the volumen discount should be applied Volume discount data

Returns dataset of all volume discounts matching the specified parameters.

Where condition Order by expression Number of records to be selected Columns to be selected

Returns volume discount with specified ID.

Volume discount ID

Sets (updates or inserts) specified volume discount.

Volume discount to be set

Deletes specified volume discount.

Volume discount to be deleted

Returns DataSet with volume discounts for specified product(SKU). Records are ordered by VolumeDiscountMinCount field.

SKU id

Returns coresponding VolumeDiscountInfo structure for the specified SKU and SKU units, if no volume discount found returns null.

SKU id SKU units

Recalculates volume discount values using the given coefficient.

Factor by which values are recalculated Number of significant digits the number should be rounded to Indicates if flat values should be recalculated Indicates if relative values should be recalculated Additional WHERE condition ID of the site which records are to be recalculated

Returns True if volume discount is valid and can be applied to the specified shopping cart item, otherwise returns False.

Shopping cart item to which the volume discount should be applied Volume discount data

Validates volume discount and calculates shopping cart item unit discount after the volume discount is applied.

Shopping cart item to which the volume discount should be applied Volume discount data

Class representing document connected with product

List of properties which should be prioritized in the macro controls (IntelliSense, MacroTree).

Inner SKU info

Registered properties

Empty constructor, allowed only if Initialize is called immediately after it.

Base constructor for inherited classes and internal purposes

Class name of the document

Registers the properties of this object

Checks the permissions of the object.

Permission type Name of the site UserInfo object If true, PermissionCheckException is thrown whenever a permission check fails

Gets the type of the given property

Property name

Returns value of column.

Column name Returns the value Returns true if the operation was successful (the value was present)

Sets value of the specified node column.

Column name Value

Returns true if the object contains specific column

Column name

Returns true if the item on specified column name changed.

Column name

Gets the original value of the given column.

Column name

Resets the object changes and keeps the new values as unchanged.

If true, the changed columns won't contain anything. If false, the previous values are discarded, but all the columns will be marked as changed.

Reverts the object changes and keeps the new values as unchanged.

Makes the object data complete.

If true, the data to complete the object is loaded from database

Returns true if the object changed.

List of columns excluded from change (separated by ';')

Gets the list of local column names for particular object

Creates a clone of the object

If true, the object is cleared to be able to create new object

Copies the node data to the destination node according to the settings.

Destination node Copy settings

This method is used by constructor to load data from provided data container and split them into internal classes.

Provided data row containing all columns Class name in format application.class Existing instance of TreeProvider

This method is used by constructor to load data from provided data container and split them into internal classes.

Provided data container containing all columns Class name in format application.class Existing instance of TreeProvider

Inserts the CMS_Tree part of the document node

Updates the CMS_Tree part of the document node

Maps the document name based on the document type settings

Returns true when node is bound to the same SKU as some other non-link node does.

Tree provider to use

Handles removing of dependencies for product document.

Settings used for deleting documents

Creates default E-Commerce SKU for the document if configured, does not save the document. Returns true on success, false on error or null when module entry not found.

Ensures the same values in document fields and their mapped SKU fields plus ensures the same values in DocumentName, DocumentSKUName and SKUName fields. Please note that SKU fields are updated only if it is possible, i.e. it is either default culture version or SKU field is empty.

True (default) - fields are synchronized in direction from document to SKU, False - fields are synchronized in direction from SKU to document True (default) - field is synchronized reversely to the direction given by fromDocumentToSKU parameter if source field of the synchronization is empty, False - all fields are always synchronized in direction given by the fromDocumentToSKU parameter

Ensures the same values in document fields and their mapped SKU fields plus ensures the same values in DocumentName, DocumentSKUName and SKUName fields. Please note that SKU fields are updated only if it is possible, i.e. it is either default culture version or SKU field is empty.

Inserts or updates the internal SKU object

Sets value of the specified SKU column and its document paired column if any.

SKU column to be set Value to be used Indicates if the given value comes from the corresponding document mapped column

For the given SKU field ensures correct value coming from its mapped document field.

Name of the SKU field Value coming from corresponding mapped document field. Indicates if type conversion from document field type to SKU field type should be performed

Returns name of the document field which is mapped to the given SKU field. If there is no document field mapped to the given SKU field, returns null.

SKU column name

Returns name of the SKU field which is mapped to the given document field. If there is no SKU field mapped to the given document field, returns null.

Document column name

Sets SKU paired column of the given document column. Returns True if paired column is found, otherwise returns False. Paired columns: (DocumentSKUName or DocumentName -> SKUName, DocumentSKUDescription -> SKUDescription, DocumentSKUShortDescription -> SKUShortDescription)

Document column Value

Sets all document paired columns of the given SKU column. Returns True if paired column is found, otherwise returns False. Paired columns: (SKUName -> DocumentSKUName and DocumentName, SKUDescription -> DocumentSKUDescription, SKUShortDescription -> DocumentSKUShortDescription)

SKU column SKU column value

Gets value from the given SKU column and synchronizes its value to the mapped document column. Alternatively synchronizes in reverse direction, i.e. from the given document column, in case SKU column value is empty.

SKU column name which is used as a source of the synchronization. Document column name which is used as an alternative source of the synchronization in case SKU column value is empty.

Gets value from the given document column and synchronizes its value to the mapped SKU column. Alternatively synchronizes in reverse direction, i.e. from the given SKU column, in case document column value is empty.

Document column name which is used as a source of the synchronization. SKU column name which is used as an alternative source of the synchronization in case document column value is empty.

Ensures data consistency.

Document SKU name

Document SKU description

Document SKU short description

Registered properties

List of prioritized properties.

SKU class - Custom document fields

E-commerce SKU (product) ID.

Returns true if the object changed.

Returns true if the object changed.

Data class configuration of the product document.